Outgoing Money from a Customer
This callback is given when the customer pays
- for his merchant order using Collect Approve
- for his merchant order using the SDK Pay
- to another UPI user by using Collect Approve
- to another UPI user using vpa, A/C+IFSC, Scan&Pay, Intent
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.
Note
The possible ‘type’ values are mapped as follows -
CUSTOMER_DEBITED_FOR_MERCHANT_VIA_COLLECT - Outgoing money from a customer to merchant via collect
CUSTOMER_DEBITED_FOR_MERCHANT_VIA_PAY - Outgoing money from a customer to merchant via pay
CUSTOMER_DEBITED_VIA_COLLECT - Outgoing money from a customer to a UPI user via collect
CUSTOMER_DEBITED_VIA_PAY - Outgoing money from a customer to a UPI user via pay
Scroll inside to view more
|
Parameter
|
Description
|
|---|---|
amount
| Amount for which customer made 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 non "U69".
|
bankCode (optional)
| IIN for the customer bank account used for transaction. Only if gatewayResponseCode is non "U69".
|
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 non "U69".
|
merchantChannelId
| Unique id for the channel via which request is made.
|
merchantCustomerId
| Merchant generated unique id for customer who sent the payment.
|
merchantId
| Unique id for merchant.
|
merchantRequestId (optional)
| Merchant generated request id as passed in the collect request. Only if gatewayResponseCode is not "U69". Only given to the party which initiates the transaction
|
orgMandateId (optional applicable only for collect mandate)
| Refers to upiRequestId used during creation of mandate.
|
payeeMcc
| Merchant Category Code of the payee merchant.
|
payeeMerchantCustomerId (optional)
| Merchant generated unique id for customer who received the payment. Only if it is an onus P2P transaction.
|
payeeName (optional)
| Name of the upi user who received the payment. Only if payment is done to a non A/C+IFSC vpa.
|
payeeVpa
| Vpa of the upi user who received the payment.
|
payerMerchantCustomerId
| Merchant generated unique id for customer who sent the payment.
|
payerMobileNumber
| Mobile number of the customer who made the payment.
|
payerVpa
| If collectType is null or TRANSACTION, Vpa of the customer who received the collect request and if collectType is MANDATE, umn of the mandate.
|
payeeAcType
| Account type of the merchant who receives the payment.
|
payeeIfsc
| Account's ifsc of the merchant who received the payment.
|
requestType (optional)
| Action which was taken on the collect request. Will not be present in case of EXPIRED callback.
|
collectType (optional)
| Differentiates between a transaction collect request (TRANSACTION) or a mandate execution collect request (MANDATE). It will only be present in case of mandate request.
|
seqNumber (optional applicable only for collect mandate)
| Denotes the recurring cycle of mandate execution. Will be received only during mandate executions. It will only be present in case of mandate request.
|
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. Refer above Note.
|
udfParameters (optional)
| Udf parameters as passed in the original payment request.
|
umn (optional applicable only for collect mandate)
| Vpa used for execution of mandate.
|