UPI Merchant Stack

Push to VPA Callback

This callback is given when the merchant initiates a push to vpa and when the same gets success/failure.

Note

  1. Merchant can get multiple callbacks for the same event type till the transaction status reaches a terminal state. Terminal states for a transaction are SUCCESS and FAILURE.

  2. gatewayResponseStatus anything other than SUCCESS and FAILURE to be considered PENDING. For PENDING & DEEMED cases, keep doing status check for next 3-5 days to get the terminal status.

Scroll inside to view more
Parameter
Description
Type
customResponse
Stringified JSON parameter for future use
Optional
amount
The amount for which transaction was performed (As passed in the request)
Mandatory
merchantId
Unique id for merchant
Mandatory
merchantChannelId
Unique id for the channel via which request is made
Mandatory
merchantRequestId
Request id used for the transaction
Mandatory
merchanVpa
VPA of the merchant from which transaction was initiated
Mandatory
merchantReason
Reason for the transaction
Optional
gatewayReferenceId
RRN for the transaction
Mandatory
gatewayTransactionId
UPI request id returned by gateway for the transaction
Mandatory
gatewayResponseCode
Response message returned by gateway for the transaction
Mandatory
gatewayResponseStatus
Response status returned by gateway for the transaction. Values : SUCCESS, FAILURE, PENDING or DEEMED. Anything other than SUCCESS and FAILURE to be considered PENDING.
Mandatory
gatewayResponseMessage
Response message returned by gateway for the transaction.
Mandatory
bankAccountHash
Hashed value of accounts passed to merchant. Present if transaction is Success.
Optional
payeeMaskedAccountNumber
Containing the account number of Customer in masked format. Present if transaction is Success.
Optional
payeeName
Name of the UPI user who received the payment. Only if payment is done to a non A/C+IFSC Global VPA. Present if transaction is Success.
Optional
payeeIfsc
Account IFSC of the customer who received the payment. Present if transaction is Success.
Optional
type
Event type of the callback - CUSTOMER_PUSH_TO_VPA
Mandatory
udfParameters
Json for udf parameters
Optional