Incoming Money to Merchant - Collect Status

This callback is given when a collect request is initiated from merchant website or app and the same gets approved/declined/expired by a upi user.

Note: This callback is also sent after mandate execution instead of the MERCHANT_OUTGOING_EXECUTE_MANDATElink icon if the merchantFlag merchantCreditedViaCollectForMandateExecute is set to true.

Scroll inside to view more
parameter
description
amount
Amount for which merchant initiated the collect request.
autoUpdateNote optional
adjFlag and adjCode separated by "|"
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.
merchantChannelId
Unique id for the channel via which request is made.
merchantId
Unique id for merchant.
merchantRequestId
Merchant generated request id as passed in web collect request.
payeeMcc
Merchant Category Code of the payee merchant.
payeeVpa
Vpa of the merchant who initiated the collect request.
payerMerchantCustomerId optional
Merchant generated unique id for customer who received the collect request. Only if it is an onus transaction.
payerName optional
Name of the upi user who received the collect request. Only if gatewayResponseCode is "00".
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.
seqNumber
optional
transactionTimestamp
Timestamp of when the web collect was initiated. (YYYY-MM-DDTHH:MM:SS+05:30)
type
Event type of the callback - MERCHANT_CREDITED_VIA_COLLECT.
udfParameters optional
Udf parameters as passed in the web collect request.
umn optional
Umn of the mandate. Will be received only during mandate execution.

Last updated 2 years ago