Incoming Create Mandate Request For Customer
Server sends a callback to the PAYER to the url configured when mandate creation request is received. This callback is only received when a mandate is requested by Payee and it has to be either approved or declined by Payer.
Scroll inside to view more
|
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 alw
|
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.
|
expiry
| Timestamp until which create mandate request is valid.
|
gatewayMandateId
| upiRequestId passed in the request.
|
gatewayReferenceId
| Customer reference number (rrn)
|
initiatedBy
| Describes whether PAYER or PAYEE has initiated the mandate.
|
isMarkedSpam
| Flag if the payeeVpa is marked as spam. true, false
|
isVerifiedPayee
| Flag if the payeeVpa is a verified vpa. true, false
|
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
| Merchant generated unique id for customer
|
merchantId
| Unique id for merchant.
|
orgMandateId
| Refers to upiRequestId used during creation of mandate.
|
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 (optional)
| Name of the Payee involved in mandate. It will be present if role is PAYER
|
payeeVpa
| Vpa of the 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. PAYER,PAYEE
|
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 (optional)
| Vpa used for execution of mandate. It will be not present, if the merchantGeneratedUmn flag is set to true.
|
validityEnd
| Date until which mandate can be executed.
|
validityStart
| Date after which mandate can be executed.
|