UPI Consumer Stack

Outgoing Collect Request from Customer

This callback is given when a customer sends a collect request to any UPI user. This enables merchant server to notify the customer, that his collect request is send successfully.

Scroll inside to view more
Parameter
Description
amount
Amount for which customer sent the collect request.
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.
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 channel id for merchant.
merchantCustomerId
Merchant generated unique id for customer who sent 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 sent the collect request.
payeeMobileNumber
Mobile number of the customer who sent the collect request.
payeeVpa
Vpa of the customer who sent the collect request.
payerName
Name of the payer to whom collect request was sent.
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 sent by customer for the collect request.
riskScore (optional)
RiskScore shared by NPCI or Bank
transactionTimestamp
Timestamp of when the collect request was sent. (YYYY-MM-DDTHH:MM:SS+05:30)
type
Event type of the callback - COLLECT_REQUEST_SENT.
udfParameters (optional)
Udf parameters as passed in the request money api call.