Callback API
This API is used to notify merchants whenever there is a change in the status of a payout transaction. For example, if a transaction status changes from Pending to Success, the callback API will be triggered automatically to inform the merchant about the status update.
Merchants can configure their callback URL from the Partner Details section.
At the time of a payment status change, we call the merchant’s callback URL, if configured, and send the following details:
Success 200
Section titled “Success 200”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| transaction_id required | Numeric | Unique payout transaction identifier | 247485 |
| partner_id required | Numeric | Partner identifier for which the payout is processed | 247485 |
| bank_account_number required | String | Bank account number used for the payout transfer | 560002379001 |
| transfer_mode required | String | Transfer mode used for payout | NEFT |
| currency required | String | Currency code for the payout | INR |
| order_id required | Alphanumeric | Merchant order identifier associated with the payout | ord0020250616v1 |
| utr_number | String | UTR reference number; null if not available yet | 52251GD34 |
| transaction_amount required | Numeric | Amount transferred for the payout | 12 |
| transaction_status required | String | Current payout transaction status | Pending |
| airpay_charge required | Numeric | Fee charged by Airpay for the transfer | 0.6 |
| bank_charge required | Numeric | Bank service charge for the payout | 1 |
| gst_amount required | Numeric | GST amount on applicable charges | 20 |
| transaction_time required | DateTime | Timestamp when transaction status was updated | 2025-06-16 12:14:02 |
Success Response (Decrypted)
Section titled “Success Response (Decrypted)”{ "transaction_id": 247485, "partner_id": 247485, "bank_account_number": "560002379001", "transfer_mode": "NEFT", "currency": "INR", "order_id": "ord0020250616v1", "utr_number": "52251GD34", "transaction_amount": 12, "transaction_status": "Pending", "airpay_charge": 0.6, "bank_charge": 1, "gst_amount": 20, "transaction_time": "2025-06-16 12:14:02"}