API Reference

Payout Webhook

Nippy provides webhook notifications to allow you to receive payout transaction updates in real-time. You can use this feature to automatically process transactions, track the status of transactions, and keep your users informed about their transactions.

Payout Webhook Notification Documentation

Introduction:

Nippy provides webhook notifications to allow you to receive payout transaction updates in real-time. You can use this feature to automatically process transactions, track the status of transactions, and keep your users informed about their transactions.

Payloads:

The webhook notification will be sent as an HTTP POST request to the URL specified in the webhook settings in your Nippy dashboard. The payload will be in JSON format and contain the following information:

  • status (boolean): This field indicates whether the transaction was successful or not. A value of true indicates a successful transaction, while false indicates a failed transaction.
  • amount (float): The amount of the transaction.
  • txn_status (string): This field indicates the status of the transaction. The possible values are success, failed, pending, and reversed.
  • transactionid (string): The unique ID of the transaction.
  • message (string): This field provides additional information about the transaction. For successful transactions, the value will be "Transaction Completed Successfully". For failed transactions, the value will be an error message.
  • BankRRN (string, optional): This field contains the UTR number or bank RRN number of the transaction. This field will only be present for successful transactions.
  • udf1 (string, optional): This field contains the value of the udf1 parameter that was passed when the transaction was created. This field will only be present if a value was passed for the udf1 parameter.

Sample Payloads:

IMPS CORRECT DATA TESTING

{  
"status": true,  
"amount": 10.1,  
"BankRRN": "310203809801",  
"txn_status": "success",  
"transactionid": "643022444535",  
"message": "Transaction Completed Successfully",  
"udf1": null  
}

IMPS WRONG DATA TESTING

{  
"status": true,  
"amount": 10.1,  
"txn_status": "reversed",  
"transactionid": "703741905996",  
"message": "reversed",  
"udf1": null  
}

UPI WRONG DATA TESTING

{  
"status": true,  
"amount": 10.1,  
"txn_status": "reversed",  
"transactionid": "463834458140",  
"message": "reversed",  
"udf1": null  
}

UPI CORRECT DATA TESTING

{  
"status": true,  
"amount": 10.1,  
"BankRRN": "310206987412",  
"txn_status": "success",  
"transactionid": "696131582305",  
"message": "Transaction Completed Successfully",  
"udf1": null  
}

Note: The udf1 field will only be present if a value was passed for the udf1 parameter.

Conclusion:

The Payout Webhook Notification is a powerful feature that allows you to receive payout transaction updates in real-time. By using this feature, you can automatically process transactions, track the status of transactions, and keep your users informed about their transactions.