v1
latestOpenAPI 3.0.02026-07-24270120.1 KBCreate Mandate
API to create new mandates with Cards or UPI
Request body
Merchant account ID
Unique ref no to identify the request. Should have only alphanumeric characters. No other characters allowed.
Transaction amount, 9 significant and 2 decimal/precision
Amount for first debit during creation of mandate. If this value is not present then the authorization will be done using Rs 1/.
Transaction Currency
Email id of customer. In case Customer email ID is not available, send guest@jiopay.com
customerName
customerMobileNo
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)
Values possible - Y | N. Implemented for N currently
Call back url on which the response will be posted on payment success/rejection.
Bill Number
Date of transaction. YYYYMMDDHHMISS
The field “blockfund” is usedfor intimating remitter bank toblock the necessary fund against the customer account. Either Y or N
Start date should be greater than the current date and cannot be lessthan the end-date value. YYYYMMDD
End date should be greater than the current date.YYYYMMDD
revokable Y or N. Mandatory if paymentMode = UPI
Date until which the mandate can be approved. Maximum upto 45 days from current date. YYYYMMDDHHMMSS. Mandatory in case of UPI Mandate only
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)
BF|ON|AF|NA (ONETIME, DAILY, AND ASPRESENTED will not have debit day rule. In that case refer - NA)
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
Mandatory in Case of UPI mandate only. Text added here will be displayed to payer in PSP app.
Bydefault it’s considered as N. Y – If Payer Account need to bevalidated (TPV) N – If Payer Account doesn’tneed to be validated
This field need to be sent if ValidatePayerAccFlag is Y. Multiple Accounts can be sent in pipe-separated format (Max Accounts allowed are 5)
This field need to be sent if ValidatePayerAccFlag is Y. Multiple IFSCs can be sent in pipe-separated format (Max IFSCs allowed are 5)
Implemented for C (Create) currently
“OT”- One Time Mandate “RECURRING”- All recurring mandates.
Notes
Card Number / token Number (in case of tokenized card). M, If payType is ‘1’ and paymentMode is CARD
Card expiration month (MM). M, If payType is ‘1’ and paymentMode is CARD
Card expiration year (YYYY). M, If payType is ‘1’ and paymentMode is CARD
Name on Card. M, If payType is ‘1’ and paymentMode is CARD
Card Verification Value. M, If payType is ‘1’ and paymentMode is CARD Optional in case token number is passed in cardNo field
Cryptogram / TAVV received from TRG/TR for transacting using token number
Mandatory if the auto pay is for UPI payment mode and accepting payerVA on your page
Merchant Aggregator ID
One of the below Values Card UPI
Hash value
Possible values are 0, 1 Where 0 = Standard (Hosted Checkout) 1 = Direct (Merchant Checkout)
Response
Successful response
Response code indicating success/failure. R1000 – Request Initiated successfully Any other value indicates failure
Description of failure. Ignore for success response.
Merchant account ID
Merchant aggregator ID
Merchant Txn ref Number
Redirection URL. Will be available in case merchant is required to redirect to complete payment authorization. Either this field or showOTPCaptureP age field will be available in response.
The transaction context generated by the PG, Needs to be sent as is to the redirectURI / authorizeURI endpoint
Hash value