Initiate Mandate

post

https://services.jiopay.co.in/api/subscription/mandate

Creates one or more recurring-payment mandates (UPI AutoPay or Card Standing Instruction). Supports bulk submission via a mandates array (server-side); the client-facing sample sends a single flattened mandate object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Creates a recurring-payment mandate (UPI AutoPay or Card Standing Instruction). The source notes bulk submission is also supported server-side via a mandates array, though no concrete example of that shape was captured — this schema reflects the single-mandate form shown in the source's example.

merchant_id

string

required

JPSL merchant ID.

customer_ref_id

string

required

Merchant's internal customer reference.

payment_method

string

enum

required

Allowed:

amount_type

string

enum

required

MAX (variable, capped) or FIXED.

Allowed:

amount

string

required

Mandate ceiling/fixed amount (decimal string).

authAmount

string

One-time authentication/registration amount (decimal string).

frequency

string

required

Debit frequency code: AS (as-and-when), MT (monthly), DL (daily), OT (one-time), etc.

start_date

string

required

Mandate start date (YYYY-MM-DD).

end_date

string

required

Mandate end date (YYYY-MM-DD).

subscription_refid

string

required

Unique subscription reference generated by merchant.

merchant_txn_no

string

Merchant transaction number (bulk/UPI payloads).

consent

boolean

required

Customer consent flag.

customer_name

string

required

Customer's name.

customer_mobile

string

required

Customer's 10-digit mobile number.

customer_email

string

required

Customer's email.

autoExecute

string

enum

Y/N — auto-execute on due date.

Allowed:

blockfund

string

enum

Y/N — block funds flag.

Allowed:

currencyCode

string

ISO numeric currency code, e.g. 356 (INR).

debitDay

string

Day of month for debit, or NA.

debitRule

string

Debit rule code, or NA.

note

string

Free-text note.

remark

string

Free-text remark.

purpose

string

required

e.g. RECURRING.

requestType

string

enum

required

C = create.

Allowed:

revokable

string

enum

Y/N.

Allowed:

validatePayerAccFlag

string

enum

Y/N.

Allowed:

payType

string

Payment type code.

paymentMode

string

e.g. Card.

card

object

Required when payment_method = CARD.

payerAccount

string

Required for UPI — bank account number.

payerIFSC

string

Required for UPI — bank IFSC.

payerVA

string

Required for UPI — payer virtual address (UPI ID).

collectByDate

string

UPI collect-by date.

udfFields

object

Up to 12 merchant-defined fields (udf21–udf32), echoed back in the response.

subscription_details

object

addlParam1

string

Additional pass-through parameter.

addlParam2

string

Additional pass-through parameter.

secureHash

string

HMAC-SHA256 signature, computed client-side before sending and validated server-side (auto-generated by the caller, not a value you choose). Algorithm: remove any existing secureHash, sort the remaining top-level keys alphabetically, join String(value).trim() per key with |, then HMAC-SHA256 the resulting string with your client_secret, hex-encoded. A second variant used by some endpoints strips comments from the raw body first and JSON-stringifies object values instead of String()-converting them — confirm which variant applies with the JPSL integration team before implementing.

Headers

x-seamless

string

enum

1 for seamless/API-driven flow, 0 for redirect flow.

Allowed:

Response

200OK