Incoming Money to Customer - Pay

This callback is given when the customer receives money from any upi user.

Note: 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, FAILURE, EXPIRED, DECLINED.

Scroll inside to view more
Parameter
Description
amount
Amount for which customer received the payment.
autoUpdateNote (optional)
adjFlag and adjCode separated by "|"
bankAccountUniqueId (optional)
Unique hash for the customer bank account used for transaction. Only if gatewayResponseCode is "00".
bankCode (optional)
IIN for the customer bank account used for transaction. Only if gatewayResponseCode is "00".
customResponse
Stringified JSON parameter for future use.
gatewayPayerResponseCode (optional)
Response code returned by gateway
gatewayPayeeResponseCode (optional)
Response code returned by gateway
gatewayPayerReversalResponseCode (optional)
Response code returned by gateway
gatewayPayeeReversalResponseCode (optional)
Response code returned by gateway
gatewayReferenceId
Customer reference number (rrn) for the transaction.
gatewayResponseCode
Response code returned by gateway for the transaction. Refer below.
gatewayResponseMessage
Verbose response message returned by gateway for the transaction.
gatewayResponseStatus
Response status returned by gateway
gatewayTransactionId
UPI request id returned by gateway for the transaction.
maskedAccountNumber (optional)
Masked account number for the customer bank account used for transaction. Only if gatewayResponseCode is "00".
merchantCustomerId
Merchant generated unique id for customer who received the payment.
merchantId
Unique id for merchant.
payeeMcc
Merchant Category Code of the payee merchant.
payeeMerchantCustomerId
Merchant generated unique id for customer who received the payment.
payeeMobileNumber
Mobile number of the customer who received the payment.
payeeVpa
Vpa of the customer who received the payment.
payerAcType
Account type of the customer who sends the payment.
payerIfsc
Account's ifsc of the customer who sends the payment.
payerMerchantCustomerId (optional)
Merchant generated unique id for customer who sent the payment. Only if it is an onus transaction.
payerName
Name of the upi user who sent the payment.
payerVpa
Vpa of the upi user who sent the payment.
refUrl
Invoice as sent by merchant or reference to the transaction in the form of url.
riskScore (optional)
RiskScore shared by NPCI or Bank
transactionTimestamp
Timestamp of when the payment was received. (YYYY-MM-DDTHH:MM:SS+05:30)
transactionType
P2M_PAY, P2P_PAY, SCAN_PAY, INTENT_PAY, P2PM_PAY, SELF_PAY, LITE_PAY, INTERNATIONAL_PAY
type
Event type of the callback - CUSTOMER_CREDITED_VIA_PAY.
udfParameters (optional)
Udf parameters as passed in the pay request.