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

Body Params application/json

Example

{
    "referenceId": "TXN9876543",
    "amount": 100,
    "amountRule": "EXACT",
    "currency": "INR",
    "payee": {
        "vpa": "eu@vpa",
        "name": "Joyce Hermann-Bogisich",
        "mcc": "0000"
    },
    "payer": {
        "vpa": "9876543210.prod@bank",
        "name": "John Doe",
        "account": "0987654321",
        "accountValidation": false
    },
    "mandateName": "Lula Hammes",
    "expiry": 100,
    "recurrence": {
        "period": "MONTHLY",
        "rule": "ON",
        "value": "cupidatat"
    },
    "validity": {
        "startAt": "2025-07-20 00:00:00",
        "endAt": "2025-10-20 00:00:00"
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Recurring Payment for Subscription",
    "upiPurposeCode": "63"
}

Request Code 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": 100,
    "amountRule": "EXACT",
    "currency": "INR",
    "payee": {
        "vpa": "eu@vpa",
        "name": "Joyce Hermann-Bogisich",
        "mcc": "0000"
    },
    "payer": {
        "vpa": "9876543210.prod@bank",
        "name": "John Doe",
        "account": "0987654321",
        "accountValidation": false
    },
    "mandateName": "Lula Hammes",
    "expiry": 100,
    "recurrence": {
        "period": "MONTHLY",
        "rule": "ON",
        "value": "cupidatat"
    },
    "validity": {
        "startAt": "2025-07-20 00:00:00",
        "endAt": "2025-10-20 00:00:00"
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Recurring Payment for Subscription",
    "upiPurposeCode": "63"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "referenceId": "string",
        "pspRefNo": "string",
        "umn": "string",
        "mandateTransactionId": "string",
        "amount": 0,
        "amountRule": "EXACT",
        "currency": "string",
        "payer": {
            "vpa": "string",
            "name": "string",
            "account": "string",
            "accountValidation": true
        },
        "mandateName": "string",
        "expiry": 0,
        "blockFund": true,
        "revocableByPayer": true,
        "recurrence": {
            "period": "ONETIME",
            "rule": "ON",
            "value": "string"
        },
        "validity": {
            "startAt": "string",
            "endAt": "string"
        },
        "pausePeriod": {
            "startAt": "string",
            "endAt": "string"
        },
        "upiReferenceUrl": "string",
        "description": "string",
        "mcc": "string",
        "upiPurposeCode": "string",
        "status": "CREATED",
        "createdAt": "string",
        "revoked": true,
        "orgTxnId": "string"
    }
}

Modified at 2025-07-23 11:07:58

UPI Autopay

Update UPI Mandate