UPI Merchant Stack

Execute Mandate Callback

Server sends a callback to the Merchant to the url configured when mandate is executed.

Note

If the merchantFlag merchantCreditedViaCollectForMandateExecute is set to true, then Collect Callback(Type: MERCHANT_CREDITED_VIA_COLLECT) is sent instead.

Scroll inside to view more
Parameter
Description
Type
amount
Amount of Mandate.
Mandatory
currentBlockedAmount
Amount Blocked in Customer Account (For SBMD Flow)
Conditional
expiry
Expiry timestamp for the collect request.
Mandatory
gatewayReferenceId
Customer reference number (rrn).
Mandatory
gatewayResponseCode
Response code returned by gateway for the transaction.
Mandatory
gatewayResponseMessage
Response message returned by gateway for the transaction.
Mandatory
gatewayResponseStatus
Response status returned by gateway.
Mandatory
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
Request id used for the mandate transaction.
Mandatory
orgMandateId
Refers to upiRequestId used during creation of mandate.
Mandatory
payeeMcc
Merchant Category Code of the payee merchant.
Mandatory
payeeVpa
Vpa of the Merchant
Mandatory
payerVpa
Vpa of the customer
Mandatory
refUrl
Invoice as sent by merchant or reference to the mandate in the form of url.
Mandatory
seqNumber (applicable only for collect mandate)
Denotes the recurring cycle of mandate execution. Will be received only during mandate executions. It will only be present in case of mandate request.
Optional
transactionTimestamp
Timestamp of when the transaction was attempted.
Mandatory
type
Event type of the callback
Mandatory
umn
Vpa used for execution of mandate.
Mandatory
udfParameters
Stringified json for udf parameters.
Optional