Update UPI Mandate

PATCH

/api/v0/upi-mandate

📌

Use this API to modify the details of an existing UPI mandate, such as updating the payment amount, frequency, or mandate expiry. This helps you manage changes to recurring payment agreements seamlessly.

Request

Header Params

Body Params application/json

Example

{
    "referenceId": "TMUM9876543",
    "amount": 2540,
    "expireAt": "2025-01-31 00:00:00",
    "validity": {
        "endAt": "2025-01-30 00:00:00"
    },
    "description": "Updated Mandate Request"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v0/upi-mandate' \
--header 'merchantAccessKey;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId": "TMUM9876543",
    "amount": 2540,
    "expireAt": "2025-01-31 00:00:00",
    "validity": {
        "endAt": "2025-01-30 00:00:00"
    },
    "description": "Updated Mandate Request"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "umn": "XYZ987",
    "referenceId": "TXN6543210",
    "mandateTransactionId": "ENKA00001234",
    "amount": 1722,
    "amountRule": "EXACT | MAX",
    "currency": "usd",
    "payee": {
        "vpa": "merchant@abc",
        "name": "ABC Pvt. Ltd.",
        "mcc": "1234"
    },
    "payer": {
        "name": "Jane Smith",
        "vpa": "1234567890.prod@bank",
        "account": "5678901234",
        "accountValidation": true
    },
    "name": "Subscription Payment",
    "expireAt": 1823418099,
    "blockFund": true,
    "revokeableByPayer": true,
    "recurrence": {
        "period": "ONE_TIME | DAILY | WEEKLY | FORTNIGHTLY | MONTHLY | BIMONTHLY | QUARTERLY | HALF_YEARLY | YEARLY | AS_PRESENTED",
        "rule": "after",
        "value": 3
    },
    "validity": {
        "startAt": 1823418099,
        "endAt": 1924519100
    },
    "pausePeriod": {
        "start_at": 1722317078,
        "end_at": 1722317078
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Automated Recurring Mandate",
    "upiPurposeCode": "10",
    "upiResponseCode": "99",
    "status": "pending",
    "createdAt": 1823418099
}

Modified at 2025-07-05 12:38:02

Create UPI Mandate

Revoke UPI Mandate