Create UPI Mandate

POST

/api/v0/upi-mandate

📌

Use this API to create a UPI mandate, allowing you to set up automated recurring payments directly from your customer’s UPI-linked bank account. This ensures secure, hassle-free collections for subscriptions, EMIs, or any recurring billing.

Request

Header Params

merchantAccessKey

string

required

Authorization

string

required

Body Params application/json

referenceId

string

required

amount

integer

required

amountRule

enum<string>

required

Allowed values:

EXACTMAX

currency

string

required

payer

object

required

name

string

required

vpa

string

required

account

string

required

accountValidation

boolean

required

mandateName

string

required

expiry

string <date-time>

required

blockFund

boolean

required

recurrence

object

required

period

enum<string>

required

Allowed values:

ONETIMEMONTHLYWEEKLYDAILYQUARTERLYBIMONTHLYFORTNIGHTLYHALFYEARLYYEARLYASPRESENTED

rule

enum<string>

required

Allowed values:

ONBEFOREAFTER

value

integer

required

validity

object

required

startAt

string <date-time>

required

endAt

string <date-time>

required

upiReferenceUrl

string

optional

description

string

optional

Example

{
    "referenceId": "TXN9876543",
    "amount": 2540,
    "amountRule": "EXACT | MAX",
    "currency": "INR",
    "payer": {
        "name": "John Doe",
        "vpa": "9876543210.prod@bank",
        "account": "0987654321",
        "accountValidation": false
    },
    "name": "Subscription Payment",
    "expiry": "2025-01-31 00:00:00",
    "blockFund": true,
    "recurrence": {
        "period": "onetime|daily|weekly|fortnightly|monthly|bimonthly|quarterly|halfyearly|yearly|aspresented",
        "rule": "ON | before | after",
        "value": 3
    },
    "validity": {
        "startAt": "2025-01-20 00:00:00",
        "endAt": "2025-01-30 00:00:00"
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Recurring Payment for Subscription"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/upi-mandate' \
--header 'merchantAccessKey;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId": "TXN9876543",
    "amount": 2540,
    "amountRule": "EXACT | MAX",
    "currency": "INR",
    "payer": {
        "name": "John Doe",
        "vpa": "9876543210.prod@bank",
        "account": "0987654321",
        "accountValidation": false
    },
    "name": "Subscription Payment",
    "expiry": "2025-01-31 00:00:00",
    "blockFund": true,
    "recurrence": {
        "period": "onetime|daily|weekly|fortnightly|monthly|bimonthly|quarterly|halfyearly|yearly|aspresented",
        "rule": "ON | before | after",
        "value": 3
    },
    "validity": {
        "startAt": "2025-01-20 00:00:00",
        "endAt": "2025-01-30 00:00:00"
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Recurring Payment for Subscription"
}'

Responses

🟢200OK

application/json

Body

umn

string

required

referenceId

string

required

mandateId

string

required

amount

integer

required

amountRule

string

required

currency

string

required

mcc

string

required

payer

object

required

name

string

required

vpa

string

required

account

string

required

accountValidation

boolean

required

name

string

required

expiry

string <date-time>

required

blockFund

boolean

required

recurrence

object

required

period

string

required

rule

string

required

value

integer

required

validity

object

required

startAt

string <date-time>

optional

endAt

string <date-time>

required

upiReferenceUrl

string

required

description

string

required

upiPurposeCode

string

required

upiResponseCode

string

required

status

string

required

createdOn

string <date-time>

required

Example

{
    "umn": "string",
    "referenceId": "string",
    "mandateId": "string",
    "amount": 0,
    "amountRule": "string",
    "currency": "string",
    "mcc": "string",
    "payer": {
        "name": "string",
        "vpa": "string",
        "account": "string",
        "accountValidation": true
    },
    "name": "string",
    "expiry": "2019-08-24T14:15:22Z",
    "blockFund": true,
    "recurrence": {
        "period": "string",
        "rule": "string",
        "value": 0
    },
    "validity": {
        "startAt": "2019-08-24T14:15:22Z",
        "endAt": "2019-08-24T14:15:22Z"
    },
    "upiReferenceUrl": "string",
    "description": "string",
    "upiPurposeCode": "string",
    "upiResponseCode": "string",
    "status": "string",
    "createdOn": "2019-08-24T14:15:22Z"
}

Modified at 2025-07-05 12:37:37

UPI Autopay

Update UPI Mandate