Mandate Status Update
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.
3) When a mandate is in PAUSE state and the pauseEnd date passes the specified date, then this callback will be sent with the value of status field as UNPAUSED. So, this callback denotes that mandate was UNPAUSED after pauseEnd got over. The status UNPAUSED denotes that mandate is resumed and can be excecuted.
4) When a future pauseStart date is given during the Pause request, then this callback will be sent with the value of status field as PAUSE when the current date matches with the specified pauseStartDate. The status PAUSE denotes that mandate is currently Paused and cannot be excecuted.
|
Parameter
|
Description
|
|---|---|
amount
| Amount of Mandate. Numeric string with two decimals.
|
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.
|
bankAccountUniqueId
| Unique id for the bank account to be linked
|
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.
|
gatewayMandateId
| UPI request id returned by gateway for the mandate request. It will be same gatewayMandateId returned during create mandate.
|
gatewayReferenceId
| Customer reference number (rrn) for the mandate operation. It will be same gatewayReferenceId returned during create mandate.
|
gatewayResponseCode
| Response code returned by gateway for the mandate. Refer the table below for all possible values.
|
gatewayResponseMessage
| Response message returned by gateway for the mandate.
|
gatewayResponseStatus
| Denotes the current status of the mandate. Refer the table below for all possible values.
|
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.
|
mandateName
| Name of the mandate.
|
mandateTimestamp
| Timestamp of when the mandate request was attempted.
|
merchantChannelId
| Unique id for the channel via which request is made.
|
merchantCustomerId (optional)
| Merchant generated unique id for customer. It will not be present if 'PAYEE' is merchant.
|
merchantId
| Unique id for merchant.
|
orgMandateId
| Refers to upiRequestId used during creation of mandate.
|
pauseEnd (conditional)
| Date until which mandate is paused. It will only be present if status is "SUCCESS" or "PAUSE"
|
pauseStart (conditional)
| Date from which mandate is paused. It will only be present if status is "SUCCESS" or "PAUSE"
|
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.
|
payeeName optioanl
| Name of the Payee involved in mandate. It will be present if role is PAYER
|
payeeVpa
| Vpa of the payee.
|
payerName (optional)
| Name of the Payer involved in mandate. It will be present if role is PAYEE
|
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.
|
payerVpa
| Vpa of the payer.
|
recurrencePattern
| Recurrence Pattern for Mandate. Possible values are ONETIME, DAILY, WEEKLY, FORTNIGHTLY,MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED
|
recurrenceRule (conditional)
| Recurrence Rule for Mandate. Possible values are ON, BEFORE, AFTER. It is not present if recurrencePattern is ONETIME, DAILY or ASPRESENTED.
|
recurrencValue (conditional)
| 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.
|
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.
|
remarks
| Any mandate summary
|
role
| Role of the customer for this mandate.
|
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.
|
transactionType
| Type of Mandate Creation.
|
type
| Event type of the callback.
|
umn
| Vpa used for execution of mandate.
|
validityEnd
| Date until which mandate can be executed.
|
validityStart
| Date after which mandate can be executed.
|
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.
|