Create Mandate Callbacks
Incoming Create Mandate For Merchant(Payer Initiated i.e Register Mandate-Intent)
Server sends a callback to Merchant to the url configured when mandate creation request is received. As mandate is initiated by PAYER the mandateTimestamp should be considered as mandateApprovalTimestamp. With Callback type as MERCHANT_INCOMING_CREATE_MANDATE.
Outgoing Create Mandate From Merchant(Payee Initiated i.e Web Mandate-Collect)
Server sends a callback to Merchant to the url configured when mandate is created. With Callback type as MERCHANT_OUTGOING_CREATE_MANDATE.
Server sends a callback to Merchant to the url configured when create mandate request sends to payer. With Callback type as MERCHANT_OUTGOING_CREATE_MANDATE_SENT.
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.Item
| 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
|
expiry
| Timestamp until which create mandate request is valid. It will be present only when payee has initiated the mandate.
| Mandatory
|
gatewayMandateId
| upiRequestId passed in the request.
| Mandatory
|
gatewayReferenceId
| Customer reference number (rrn).
| Mandatory
|
gatewayResponseCode
| Response code returned by gateway for the mandate.
| Mandatory
|
gatewayResponseMessage
| Response message returned by gateway for the mandate.
| Mandatory
|
gatewayResponseStatus
| Response status returned by gateway.
| Mandatory
|
initiatedBy
| Describes whether PAYER or PAYEE has initiated the mandate.
| Mandatory
|
mandateApprovalTimestamp
| Time instant at which create mandate request was approved. Only present if mandate was initiatedBy Payee. Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format.
| Mandatory
|
mandateName
| Name of the mandate.
| Mandatory
|
mandateTimestamp
| Timestamp of when the mandate request was attempted. Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format.
| 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. It is merchantRequestId that is passed during initiation of mandate.
| Mandatory
|
orgMandateId
| Refers to upiRequestId used during creation of mandate.
| Mandatory
|
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
|
payeeVpa
| Vpa of the payee.
| Mandatory
|
payerName
| Name of the Payer involved in mandate.
| Mandatory
|
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
|
payerAccountHash
| sha256( account Number + first 4 digit of account IFSC).
| Optional
|
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
|
recurrenceValue
| 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. PAYER,PAYEE
| 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
|
transactionType
| Type of Mandate Creation
| Mandatory
|
type
| Event type of the callback
| Mandatory
|
umn
| Vpa used for execution of mandate. It will not be present if gatewayResponseStatus is EXPIRED or if it is not received from NPCI due to validation failure at Payer PSP during approve mandate.
| Optional
|
validityEnd Date
| until which mandate can be executed.
| Mandatory
|
validityStart
| Date after which mandate can be executed.
| Mandatory
|
udfParameters
| Stringified json for udf parameters. It will be present only if passed during web mandate API request.
| Optional
|
- Have questions?
- Need help? Contact support
- LLM? Read llms.txt
