UPI Merchant Stack

Mandate Status Update Callback

Server sends a callback to the Merchant to the url configured when mandate status gets updated. This status update is internal and does not depends on NPCI. It will be sent in the following scenarios :

1) When ONETIME mandate gets executed successfully or three attempts to execute ONETIME mandate gets over, then this callback will be sent with the value of status field as COMPLETED.

2) When validityEnd of a mandate passes the specified date, then this callback will be sent with the value of status field as COMPLETED.

Scroll inside to view more
Parameter
Description
Type
amount
Amount of Mandate. Numeric string with two decimals.
Mandatory
amountRule
Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount.
Mandatory
blockFund
Denotes whether customer's fund should be blocked or not. For Onetime mandate, value can be true or false and for recurring mandate it is always false.
Mandatory
gatewayMandateId
UPI request id returned by gateway for the mandate request. It will be same gatewayMandateId returned during create mandate.
Mandatory
gatewayReferenceId
Customer reference number (rrn) for the mandate operation. It will be same gatewayReferenceId returned during create mandate.
Mandatory
gatewayResponseCode
Response code returned by gateway for the mandate. Refer the table below for all possible values.
Mandatory
gatewayResponseMessage
Response message returned by gateway for the mandate.
Mandatory
gatewayResponseStatus
Denotes the current status of the mandate. Refer the table below for all possible values.
Mandatory
initiatedBy
Describes whether PAYER or PAYEE has initiated the mandate request. Its value will be PAYER or PAYEE depending to whom this callback is being send. If it is send to PAYER, value will PAYER and same for PAYEE. It will have same value as role.
Mandatory
mandateName
Name of the mandate.
Mandatory
mandateTimestamp
Timestamp of when the mandate request was attempted.
Mandatory
merchantChannelId
Unique id for the channel via which request is made.
Mandatory
merchantId
Unique id for merchant.
Mandatory
orgMandateId
gatewayMandateId passed in the response of webMandate or create mandate.
Mandatory
pauseEnd
Date until which mandate is paused. It will only be present if status is "SUCCESS" or "PAUSE"
Conditional
pauseStart
Date from which mandate is paused. It will only be present if status is "SUCCESS" or "PAUSE"
Conditional
payeeMcc
Merchant Category Code of the payee merchant. If Payee is a customer it will be "0000" else it will be a 4 digit numeric string.
Mandatory
payeeName
Name of the Payee involved in mandate. It will be present if role is PAYER
Optional
payeeVpa
Vpa of the payee.
Mandatory
payerName
Name of the Payer involved in mandate. It will be present if role is PAYEE
Optional
payerRevocable
Denotes whether mandate can be revoke by payer or not. If while requesting mandate Payee passes this flag is true, mandate can be revoked by Payer else it cannot be revoked by Payer. For Onetime mandate, value can be true or false and for recurring mandate it is always true. Default value is true.
Mandatory
payerVpa
Vpa of the payer.
Mandatory
recurrencePattern
Recurrence Pattern for Mandate. Possible values are ONETIME, DAILY, WEEKLY, FORTNIGHTLY,MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED
Mandatory
recurrenceRule
Recurrence Rule for Mandate. Possible values are ON, BEFORE, AFTER. It is not present if recurrencePattern is ONETIME, DAILY or ASPRESENTED.
Conditional
recurrencValue
Recurrence Value for Mandate. Possible values are 1-31 and depends on the recurrencePattern. It is not present if recurrencePattern is ONETIME, DAILY or ASPRESENTED.
Conditional
refUrl
Invoice as sent by merchant or reference to the mandate in the form of url. This is a field which is majorly for future purpose and is send by the Payee.
Mandatory
remarks
Any mandate summary
Mandatory
role
Role of the customer for this mandate.
Mandatory
shareToPayee
Denotes whether mandate should be shared with payee or not. For Onetime mandate, value can be true or false and for recurring mandate it is always true. Default value is true.
Mandatory
status
Updated Status of the mandate. It will be COMPLETED if mandate validity end gets over or if Onetime mandate gets executed.Various fields in this callback like gatewayMandateId, gatewayReferenceId, merchantRequest depends on the value of status.
Mandatory
transactionType
Type of Mandate Creation.
Mandatory
type
Event type of the callback.
Mandatory
umn
Vpa used for execution of mandate.
Mandatory
validityEnd
Date until which mandate can be executed.
Mandatory
validityStart
Date after which mandate can be executed.
Mandatory