Get UPI Mandate

GET

/api/v0/upi-mandate/{referenceId}

📌

Use this API to retrieve the details of a specific UPI mandate by its ID. This helps you check the status, amount, frequency, and other mandate information for easier tracking and customer support.

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://olympus-pg-uat.enkash.in/api/v0/upi-mandate/' \
--header 'merchantAccessKey;' \
--header 'Authorization;'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

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

Modified at 2025-07-05 12:39:30

Revoke UPI Mandate

UPI Mandate Callback