Request Method :: POST

Description:The Webhook API is used to receive real-time updates from the system whenever there is a status change in a transaction. Once configured, the system will automatically send callbacks with updated transaction data to the registered endpoint, eliminating the need for manual status checks.

Headers

---

Content-Type: application/JSON

header_secrets:  To be shared during integration by ISU Team

pass_key:  To be shared during integration by ISU Team

Request Body Parameters

Parameters	Description	Min Length	Max Length	Data type	Mandatory/Optional
txnAmt	Transaction amount for which transaction is initiated	1	10	String	Mandatory
transaction_note	Transaction Note	1	50	String	Mandatory
txnId	Transaction ID	18	18	String	Mandatory
paymentMode	Payment Mode (e.g., UPI_INTENT)	1	10	String	Mandatory
status	SUCCESS / FAILED	1	10	String	Mandatory
statusCode	API Status Code	1	3	String	Mandatory
statusDesc	API Status Description	1	50	String	Mandatory
transaction_date	DateTime of transaction (ISO format)	10	30	String	Mandatory
payer_vpa	Payer UPI ID	1	100	String	Mandatory
payee_vpa	Payee's VPA of Merchant for Payment Collection	1	100	String	Mandatory
platform	Platform of transaction (e.g., MOBILE)	1	10	String	Mandatory
customerName	Customer's Name	1	50	String	Mandatory
rrn	Bank Reference Number	1	40	String	Mandatory
clientRefId	Unique client reference ID needs to be generated by partner/Merchant for each new transaction	10	19	String	Mandatory
parama	Optional field	0	100	String	Optional
paramb	Optional field	0	100	String	Optional
paramc	Optional field	0	100	String	Optional
walletid	Wallet Transaction ID of Merchant	1	50	String	Mandatory

Sample Request Body

---

{ "txnAmt": "5000", "transaction_note": "Payment for Order #12345", "txnId": "TXN987654321", "paymentMode": "UPI_INTENT", "status": "SUCCESS", "statusCode": "0", "statusDesc": "Transaction Successful", "transaction_date": "2024-12-31T14:30:00Z", "payer_vpa": "payer@upi", "payee_vpa": "payee@upi", "platform": "MOBILE", "customerName": "John Doe", "rrn": "123456789012", "clientRefId": "CR123456789", "parama": "OptionalValuea", "paramb": "OptionalValueb", "paramc": "OptionalValuec", "walletid": "WAL123456" }

Response Body Parameters

Parameters	Description	Min Length	Max Length	Data type
status	Status of the transaction operation.	1	10	String
statusDesc	Status Description E.g. - Success.	1	50	String

Sample Response Body

---

SUCCESS:

{ "status": 0, "statusDesc": "success" }

 

FAILED:

{ "status": 1, "statusDesc": "Failure" }

Status Codes

Code	Significance	Description
0	SUCCESS	Success
1	FAILED	Unsuccessful