Incoming Money to Customer - Collect Status
This callback is given when the customer sends a collect request to any upi user and when the same gets approved/declined/expired.
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 initiated the collect request.
|
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.
|
expiry
| Expiry timestamp for the collect request.
|
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".
|
merchantChannelId
| Unique id for the channel via which request is made.
|
merchantCustomerId
| Merchant generated unique id for customer who initiated the collect request.
|
merchantId
| Unique id for merchant.
|
merchantRequestId
| Merchant generated request id as passed in the collect request.
|
payeeMcc
| Merchant Category Code of the payee merchant.
|
payeeMerchantCustomerId
| Merchant generated unique id for customer who initiated the collect request.
|
payeeMobileNumber
| Mobile number of the customer who initiated the collect request.
|
payeeVpa
| Vpa of the customer who initiated the collect request.
|
payerAcType
| Account type of the customer who received the payment.
|
payerIfsc
| Account's ifsc of the customer who received the payment.
|
payerMerchantCustomerId (optional)
| Merchant generated unique id for customer who received the collect request. Only if it is an onus transaction.
|
payerName
| Name of the upi user who received the collect request.
|
payerVpa
| Vpa of the upi user who received the collect request.
|
refUrl
| Invoice as sent by merchant or reference to the transaction in the form of url.
|
remarks
| Remarks passed when intiating the collect request.
|
riskScore (optional)
| RiskScore shared by NPCI or Bank
|
transactionTimestamp
| Timestamp of when the collect was initiated. (YYYY-MM-DDTHH:MM:SS+05:30)
|
type
| Event type of the callback - CUSTOMER_CREDITED_VIA_COLLECT.
|
udfParameters (optional)
| Udf parameters as passed in the collect request.
|