Collect Callback
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 Execute Mandate Callback(Type: MERCHANT_OUTGOING_EXECUTE_MANDATE) if the merchantFlag merchantCreditedViaCollectForMandateExecute is set to true.
Scroll inside to view more
|
Parameter
|
Description
|
Type
|
|---|---|---|
amount
| Amount for which merchant initiated the collect request.
| Mandatory
|
autoUpdateNote
| adjFlag and adjCode separated by "|".
| Optional
|
customResponse
| Stringified JSON parameter for future use.
| Mandatory
|
expiry
| Expiry timestamp for the collect request.
| Optional
|
gatewayPayerResponseCode
| Response code returned by gateway
| optional
|
gatewayPayeeResponseCode
| Response code returned by gateway
| optional
|
gatewayPayerReversalResponseCode
| Response code returned by gateway
| optional
|
gatewayPayeeReversalResponseCode
| Response code returned by gateway
| optional
|
gatewayReferenceId
| Customer reference number (rrn) for the transaction.
| Mandatory
|
gatewayResponseCode
| Response code returned by gateway for the transaction. Refer below.
| Mandatory
|
gatewayResponseMessage
| Verbose response message returned by gateway for the transaction.
| Mandatory
|
gatewayResponseStatus
| Response status returned by gateway
| Optional
|
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 web collect request.
| Mandatory
|
payeeMcc
| Merchant Category Code of the payee merchant.
| Mandatory
|
payeeVpa
| Vpa of the merchant who initiated the collect request.
| Mandatory
|
payerMerchantCustomerId
| Merchant generated unique id for customer who received the collect request. Only if it is an onus transaction.
| Optional
|
payerName
| Name of the upi user who received the collect request. Only if gatewayResponseCode is "00".
| Optional
|
payerVpa
| Vpa of the upi user who received the collect request.
| Optional
|
refUrl
| Invoice as sent by merchant or reference to the transaction in the form of url.
| Mandatory
|
seqNumber
| Sequence Number of execution.
| Optional
|
transactionTimestamp
| Timestamp of when the web collect was initiated. (YYYY-MM-DDTHH:MM:SS+05:30)
| Mandatory
|
type
| Event type of the callback - MERCHANT_CREDITED_VIA_COLLECT.
| Mandatory
|
payerAccBin
| First 10 characters of the account number(Credit)
| Optional
|
tpvValidationStatus
| Whether TPV was success or failure
| Conditional
|
payerAccountHash
| sha256( account Number + first 4 digit of account IFSC).
| Conditional
|
riskScore
| RiskScore shared by NPCI or Bank
| Optional
|
subMerchantChannelId
| Unique id for the channel via which request is made. Only if present as a subMerchant.
| Optional
|
subMerchantId
| Unique id for subMerchant. Only if present as a subMerchant.
| Optional
|
payerIfsc
| Account ifsc of the customer who sends the payment
| Optional
|
payerAcType
| Account type of the customer who sends the payment.
| Optional
|
payerActype
| Account type of the customer who sends the payment.
| Optional
|
umn
| Umn of the mandate. Will be received only during mandate execution.
| Optional
|
orgMandateId
| Refers to upiRequestId used during creation of mandate
| Optional
|
mandateIntentPayUrl
| Intent url for mandate
| Optional
|
udfParameters
| Udf parameters as passed in the web collect request.
| Optional
|
Note
payerAccBin, payerIfsc and payerAccType are supported in only callbackversion > 1
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
