v1

latestOpenAPI 3.1.02026-08-045901.5 MB

UPI Mandate

post/payment/upimandate

Request body

upiIdstring required

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

mandate_amountinteger required

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

order_amountstring required

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

start_datestring required

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

end_datestring required

The date on which the UPI mandate automatically expires.

frequency'AS' | 'MT' | 'WK' | 'QT' | 'HY' | 'YR' required

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

debitRule'ON' | 'BEFORE' | 'AFTER' required

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

debitDaystring 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.

notestring

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

remarkstring

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

customer_namestring

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

customer_emailstring

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

customer_mobilenumber float

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

autoExecutestring

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

Response

200

statusinteger
messagestring

Example response

{
  "status": 200,
  "message": "Transaction Initiated",
  "data": {
    "transaction_id": "1765886351475031958",
    "BankRRN": "100001955780"
  }
}