UPI Mandate

Body Params
string
required

The customer’s UPI ID from which the mandate amount will be debited.

int32
required

The fixed amount that will be debited from the customer’s UPI account on each cycle.

string
required

The transaction amount to be charged for the current order or execution under the mandate.

string
required

The date from which the UPI mandate becomes active and eligible for debit.

string
required

The date on which the UPI mandate automatically expires.

string
enum
required
Defaults to AS

Defines how often the mandate amount will be debited.(Mandate Frequency can be : WK=Weekly MT=Monthly QT=Quarterly HY=half yearly YR= yearly)

Allowed:
string
enum
required
Defaults to ON

Specifies the rule for when the debit should occur relative to the scheduled date.

Allowed:
string
required

The day on which the debit will be attempted based on the selected mandate frequency. For WEEKLY, the value should be between 1 (Monday) and 7 (Sunday). For MONTHLY, QUARTERLY, HALF-YEARLY, and YEARLY, the value should be between 1 and 30/31 depending on the month. For AS (As Presented) frequency, this field is not mandatory as there is no fixed debit day.

string

Note displayed to the user in the UPI app (PSP) during mandate approval. Maximum length is 50 characters.

string

Remark or reference entered by the payer for personal identification of the mandate. Maximum length is 50 characters.

string

Full name of the customer for whom the UPI mandate is being created.

string

Email address of the customer used for mandate-related communication and reference.

float

Mobile number of the customer registered with the UPI account for mandate notifications and verification.

string

Indicates whether the mandate should be automatically executed once it becomes active, without manual intervention.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json