v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Create Mandate

API to create new mandates with Cards or UPI

post/pg/api/mandate/initiate

Request body

merchantIdstring required

Merchant account ID

merchantTxnNostring required

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

amountstring

Transaction amount, 9 significant and 2 decimal/precision

authAmountstring

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

currencyCodestring required

Transaction Currency

customerEmailIDstring required

Email id of customer. In case Customer email ID is not available, send guest@jiopay.com

customerNamestring

customerName

customerMobileNostring

customerMobileNo

amountLimitstring 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)

autoExecutestring required

Values possible - Y | N. Implemented for N currently

returnURLstring required

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

billNumberstring required

Bill Number

txnDatestring

Date of transaction. YYYYMMDDHHMISS

blockfundstring

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

validityStartDatestring YYYYMMDD required

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

validityEndDatestring YYYYMMDD required

End date should be greater than the current date.YYYYMMDD

revokablestring

revokable Y or N. Mandatory if paymentMode = UPI

collectByDatestring

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

debitDaystring

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)

debitRulestring

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

frequencystring 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

notestring

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

validatePayerAccFlagstring

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

payerAccountstring

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

payerIFSCstring

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

requestTypestring required

Implemented for C (Create) currently

purposestring

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

remarkstring

Notes

cardNostring

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

cardExpiryMonthstring

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

cardExpiryYearstring

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

cardHolderNamestring

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

cvvstring

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

cryptogramstring

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

payerVAstring

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

aggregatorIDstring

Merchant Aggregator ID

paymentModestring required

One of the below Values Card UPI

accountNostring
accountIFSCstring
secureHashstring required

Hash value

paytypestring required

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

Response

Successful response

responseCodestring

Response code indicating success/failure. R1000 – Request Initiated successfully Any other value indicates failure

responseDescriptionstring

Description of failure. Ignore for success response.

merchantIdstring

Merchant account ID

aggregatorIDstring

Merchant aggregator ID

merchantTxnNostring

Merchant Txn ref Number

redirectURIstring

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.

tranCtxstring

The transaction context generated by the PG, Needs to be sent as is to the redirectURI / authorizeURI endpoint

secureHashstring

Hash value