Pay Callback
This callback is given to merchant when a customer pays for his order on merchant app. Triggered for UPI Pay transaction.
Note
Note: In case the tpvValidationStatus is failure (meaning TPV has failed) but the gatewayResponseStatus is success or deemed - payee psp could not fail the transaction (due to technical or ecosystem limitations) in that case please initiate a refund. Payee PSP will also initiate a refund in 30 minute batches and if merchant missed to refund the PSP will do it on behalf of the merchant.
This should not happen but this is an edge case that should be handled for superior customer experience.
Scroll inside to view more
|
Parameter
|
Description
|
Type
|
|---|---|---|
amount
| Amount for the transaction
| Mandatory
|
autoUpdateNote
| adjFlag and adjCode separated by "\
| Optional
|
customResponse
| Stringified JSON parameter for future use.
| Optional
|
gatewayPayerResponseCode
| Response code returned by gateway
| Optional
|
gatewayPayeeRes ponseCode
| Response code returned by gateway
| Optional
|
gatewayPayerReve rsalResponseCode
| Response code returned by gateway
| Optional
|
gatewayPayeeRev ersalResponseCode
| Response code returned by gateway
| Mandatory
|
gatewayReference Id
| Customer reference number (rrn) for the transaction
| Mandatory
|
gatewayResponse Code
| Verbose response message returned by gateway for the transaction
| Mandatory
|
gatewayResponse Status
| Response status returned by gateway for the transaction
| Mandatory
|
gatewayTransactionId
| UPI request id returned by gateway for the transaction
| Mandatory
|
merchantChannelId
| Unique id for the channel via which request is made
| Mandatory
|
merchantId
| Unique id for merchant
| Mandatory
|
merchantRequestId
| Merchant generated request id as passed in the pay request
| Mandatory
|
payeeMcc
| Merchant Category Code of the payee merchant
| Mandatory
|
payeeVpa
| Vpa of the merchant who received the payment
| Mandatory
|
payerName
| Name of the customer who sent the payment
| Mandatory
|
payerMerchantCustomerId
| Merchant generated unique id for customer who sent the payment. Only if it is an onus transaction
| Optional
|
payerVpa
| Vpa of the customer who sent the payment.
| Mandatory
|
refUrl
| Invoice as sent by merchant or reference to the transaction in the form of url
| Mandatory
|
transactionTimestamp
| Timestamp of when the pay was initiated. (YYYY-MM-DDTHH:MM:SS+05:30)
| Mandatory
|
type
| Event type of the callback - MERCHANT_CREDITED_VIA_PAY.
| Mandatory
|
payerActype
| Type of the Payer Account.
| Mandatory
|
payerIfsc
| IFSC of the payer account
| Mandatory
|
payerAccBin
| BIN of the credit card in case the payerAccType is CREDIT
| Mandatory
|
tpvValidationStatus
| Status of TPV Validation
| Conditional
|
payerAccountHash
| Account hash of account selected by user on payer app (received via NPCI)
| Conditional
|
subMerchantId
| Unique id for subMerchant. Only if present as a subMerchant
| Optional
|
subMerchantChannelId
| Unique id for the channel via which request is made. Only if present as a subMerchant.
| Optional
|
remarks
| Transaction note
| Optional
|
gstAmount
| GST amount deducted
| Optional
|
mdrAmount
| MDR amount deducted
| Optional
|
netSettlementAmount
| Net amount settled post deductions
| Optional
|
settlementStatus
| Status of settlement
| Optional
|
settlementId
| Identifier for settlement
| Optional
|
udfParameters
| Udf parameters as passed in the pay request
| Optional
|
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
