Incoming Collect Request to Customer
This callback is given when a customer receives a collect request from any UPI user. This enables merchant server to notify the customer, so that she can take action on the request.
Scroll inside to view more
|
Parameter
|
Description
|
|---|---|
amount
| Amount for which customer received the collect request.
|
customResponse
| Stringified JSON parameter for future use.
|
expiry
| Expiry timestamp for the collect request.
|
gatewayReferenceId
| Customer reference number (rrn) for the transaction.
|
gatewayTransactionId
| UPI request id returned by gateway for the transaction.
|
isVerifiedPayee
| Stringified boolean flag if the payee is a verified vpa.
|
isMarkedSpam
| Stringified boolean flag if the payee is marked as spam.
|
merchantCustomerId
| Merchant generated unique id for customer who received the collect request.
|
merchantId
| Unique id for merchant.
|
payeeMcc
| Merchant Category Code of the payee merchant.
|
payeeMerchantCustomerId (conditional)
| Merchant generated unique id for customer who initiated the collect request. (Only present for ONUS transactions)
|
payeeName
| Name of the upi user who sent the collect request.
|
payeeVpa
| Vpa of the upi user who sent the collect request.
|
payerMerchantCustomerId
| Merchant generated unique id for customer who received the collect request.
|
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.
|
collectType (optional)
| Differentiates between a transaction collect request (TRANSACTION) or a mandate execution collect request (MANDATE).
|
seqNumber (optional)
| Denotes the recurring cycle of mandate execution. Will be received only during mandate executions.
|
refUrl
| Invoice as sent by merchant or reference to the transaction in the form of url.
|
remarks
| Remarks sent by upi user for the collect request.
|
riskScore (optional)
| RiskScore shared by NPCI or Bank
|
transactionTimestamp
| Timestamp of when the collect request was received. (YYYY-MM-DDTHH:MM:SS+05:30)
|
type
| Event type of the callback - COLLECT_REQUEST_RECEIVED.
|