Skip to content

Callback API

| View as Markdown

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:

ParameterType ValueDescriptionValue Like
transaction_id requiredNumericUnique payout transaction identifier247485
partner_id requiredNumericPartner identifier for which the payout is processed247485
bank_account_number requiredStringBank account number used for the payout transfer560002379001
transfer_mode requiredStringTransfer mode used for payoutNEFT
currency requiredStringCurrency code for the payoutINR
order_id requiredAlphanumericMerchant order identifier associated with the payoutord0020250616v1
utr_numberStringUTR reference number; null if not available yet52251GD34
transaction_amount requiredNumericAmount transferred for the payout12
transaction_status requiredStringCurrent payout transaction statusPending
airpay_charge requiredNumericFee charged by Airpay for the transfer0.6
bank_charge requiredNumericBank service charge for the payout1
gst_amount requiredNumericGST amount on applicable charges20
transaction_time requiredDateTimeTimestamp when transaction status was updated2025-06-16 12:14:02
{
"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"
}