Webhook API
Description - Your organization will provide us a Call-back URL with the following configurations:
- The Call-back URL should be of Method Type POST
- Content-type should be of Type application/JSON.
- The Call-back URL should have the below request format. The Response also has been provided for your reference.
Headers
Content-Type: application/JSON |
Request Body Parameters
FIELD | DESCRIPTION | DATA TYPE | MANDATORY/NOT MANDATORY |
txnAmt | Transaction Amount Should be between 1 to 100000. E.g. - "1200" | String | Mandatory |
transaction_note | Remarks. | String | Mandatory |
order_no | Transaction Number | String | Mandatory |
transaction_id | Transaction ID. E.g.- 48629174022183297 | String | Mandatory |
transaction_type | Transaction Type E.g.- "QR_COLLECT/ VPA_COLLECT" | String | Mandatory |
status | Status of Transaction, Must not be NULL. E.g.- "SUCCESS/FAILED" | String | Mandatory |
statusCode | Status Code. 0 signifies Success and other codes signifies failure | String | Mandatory |
statusDesc | Status Description E.g. - "Transaction Successful." | String | Mandatory |
wallet_id | The Wallet ID. | String | Mandatory |
origin_identifier | Origin Identifier. From where the transaction initiated means the payer application. | String | Mandatory |
transaction_status_code | Transaction Status Code | String | Mandatory |
transaction_date | Date of transaction | String | Mandatory |
payer_vpa | VPA of Payer | String | Mandatory |
payee_vpa | VPA of Payee. E.g. - "iserveupvtltd@indus" | String | Mandatory |
platform | Type of Platform - E.g. - “upitransfer” | String | Mandatory |
customerName | Customer Name. E.g. - “Jane” | String | Mandatory |
rrn | Bank reference number. E.g.- “648987427109” | String | Mandatory |
clientRefId | Client Reference ID, It must Not be NULL. E.g. - “429748217021” | String | Mandatory |
param_b | To be used as per discretion. | AlphanumericString | Not Mandatory |
Param_c | To be used as per discretion. | AlphanumericString | Not Mandatory |
Sample Request Body JSON
Sample Response Body
Success :
FAILED:
Status Codes
Code | Significance | Description |
0 | SUCCESS | Success |
1 | FAILED | Unsuccessful |