Enkash Developer Portal
Home
Home
Login
  1. UPI Autopay
  • Back to home
  • Payment Gateway APIs
  • Merchant
    • Generate Authorization Token
      POST
    • Payment Modes Details
      GET
  • Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get Order By Merchant Order Id
      GET
    • Get BNPL Payment Methods
      GET
    • Get Dynamic UPI QR
      GET
    • UPI Intent Links
      GET
  • Payment
    • Submit Payment Request
      POST
    • Get Transaction Status
      GET
    • Validate OTP
      POST
    • Resend OTP
      GET
    • Payment Notify Request
      POST
    • Get UPI Transaction Status
      GET
    • Verify UPI VPA
      POST
  • Refund
    • Refund
      POST
  • Settlement
    • Get Settlement Payout By ID
      GET
    • Search Settlement Payouts
      POST
  • Split Settlement
    • Create Split Settlement Account
    • Update Split Settlement Account
    • Get All Split Settlement Account
    • Deactivate Split Settlement Account
    • Activate Split Settlement Account
    • Submit Payment with Split Details
    • Edit Or Deferred Split Settlement
  • E-Commerce Plugins
  • UPI QR
    • Create UPI QR
    • Get UPI QR
    • Search UPI QR
    • Create Customer
    • Search Customer
    • Cancel UPI QR
  • UPI Autopay
    • Create UPI Mandate
      POST
    • Update UPI Mandate
      PATCH
    • Revoke UPI Mandate
      PATCH
    • Get UPI Mandate
      GET
    • UPI Mandate Callback
      POST
    • Mandate Pre-debit Notification
      POST
    • Execute Mandate Debit
      POST
    • Mandate Debit Callback
      POST
  • Payment Links
    • Payment Link APIs
    • Create Payment Link
    • Get Payment Link Details
    • Delete Payment Link
    • Webhook Request
  1. UPI Autopay

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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v0/upi-mandate/' \
--header 'merchantAccessKey;' \
--header 'Authorization;'

Responses

🟢200OK
application/json
Body

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:22Z",
    "blockFund": true,
    "revokeableByPayer": true,
    "recurrence": {
        "period": "string",
        "rule": "string",
        "value": 0
    },
    "validity": {
        "startAt": "2019-08-24T14:15:22Z",
        "endAt": "2019-08-24T14:15:22Z"
    },
    "pausePeriod": {
        "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:39:30
Previous
Revoke UPI Mandate
Next
UPI Mandate Callback
Built with