Create Mandate

API to create new mandates with Cards or UPI

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Merchant account ID

string
required

Unique ref no to identify the request. Should have only alphanumeric characters. No other characters allowed.

string

Transaction amount, 9 significant and 2 decimal/precision

string

Amount for first debit during creation of mandate. If this value is not present then the authorization will be done using Rs 1/.

string
required
Defaults to 356

Transaction Currency

string
required
Defaults to [email protected]

Email id of customer. In case Customer email ID is not available, send [email protected]

string

customerName

string

customerMobileNo

string
required

Indicates whether subscription amount is fixed or has a maximum limit. The following values are possible • M - indicates the maximum amount that can be charged for the subscription• F – indicates the fixed amount to be charged for the subscription. For upi, only maximum is allowed. This is required to allow for token debit (small value transaction)

string
required

Values possible - Y | N. Implemented for N currently

string
required

Call back url on which the response will be posted on payment success/rejection.

string
required

Bill Number

string

Date of transaction. YYYYMMDDHHMISS

string

The field “blockfund” is usedfor intimating remitter bank toblock the necessary fund against the customer account. Either Y or N

string
required
Defaults to 20231119

Start date should be greater than the current date and cannot be lessthan the end-date value. YYYYMMDD

string
required
Defaults to 20291119

End date should be greater than the current date.YYYYMMDD

string

revokable Y or N. Mandatory if paymentMode = UPI

string
Defaults to 20231119121212

Date until which the mandate can be approved. Maximum upto 45 days from current date. YYYYMMDDHHMMSS. Mandatory in case of UPI Mandate only

string

If the frequency selected as WEEKLY then the value will be from (1- Monday to 7- Sunday) FORTNIGHTLY (1-15 days) MONTHLY|BIMONTHLY|QUARTERLY|HALFYEARLY|YEARLY| (1-30/31 days)

string

BF|ON|AF|NA (ONETIME, DAILY, AND ASPRESENTED will not have debit day rule. In that case refer - NA)

string
required

Mandate Frequency can be OT = one time (only for UPI Mandate, not applicable in Card) DL = Daily AS = ASPRESENTED WK = Weekly BM = bi-monthly MT =Monthly QT = Quarterly HY = half yearly YR = yearly

string

Mandatory in Case of UPI mandate only. Text added here will be displayed to payer in PSP app.

string

Bydefault it’s considered as N. Y – If Payer Account need to bevalidated (TPV) N – If Payer Account doesn’tneed to be validated

string

This field need to be sent if ValidatePayerAccFlag is Y. Multiple Accounts can be sent in pipe-separated format (Max Accounts allowed are 5)

string

This field need to be sent if ValidatePayerAccFlag is Y. Multiple IFSCs can be sent in pipe-separated format (Max IFSCs allowed are 5)

string
required

Implemented for C (Create) currently

string

“OT”- One Time Mandate “RECURRING”- All recurring mandates.

string

Notes

string

Card Number / token Number (in case of tokenized card). M, If payType is ‘1’ and paymentMode is CARD

string

Card expiration month (MM). M, If payType is ‘1’ and paymentMode is CARD

string

Card expiration year (YYYY). M, If payType is ‘1’ and paymentMode is CARD

string

Name on Card. M, If payType is ‘1’ and paymentMode is CARD

string

Card Verification Value. M, If payType is ‘1’ and paymentMode is CARD Optional in case token number is passed in cardNo field

string

Cryptogram / TAVV received from TRG/TR for transacting using token number

string

Mandatory if the auto pay is for UPI payment mode and accepting payerVA on your page

string

Merchant Aggregator ID

string
required

One of the below Values Card UPI

string
string
string
required

Hash value

string
required
Defaults to 1

Possible values are 0, 1 Where 0 = Standard (Hosted Checkout) 1 = Direct (Merchant Checkout)

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json