Enkash Developer Portal
Home
Home
Login
  1. UPI Autopay
  • Back to home
  • Payment Gateway APIs
  • Authorisation
    • Get Authorization Token
  • Order
    • Create Order
    • Get Order Status
    • Get Order By Merchant Order Id
    • Get BNPL Payment Methods
    • Get Dynamic UPI QR
    • UPI Intent Links
  • Payment
    • Submit Payment Request
    • Get Transaction Status
    • Validate OTP
    • Resend OTP
    • Payment Notify Request
    • Get UPI Transaction Status
    • Verify UPI VPA
  • Refund
    • Refund
  • Settlement
    • Get Settlement Payout By ID
    • Search Settlement Payouts
  • 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

Execute Mandate Debit

POST
/api/v0/upi-mandate/execute
đź“Ś
Use this API to initiate a debit against an active UPI mandate. This allows you to collect recurring payments—such as subscriptions, EMIs, or fees—securely and automatically from your customer’s UPI-linked account.

Request

Header Params
merchantAccessKey
string 
required
Authorization
string 
required
Body Params application/json
mandateId
string 
required
amount
number 
required
remarks
string 
required
Example
{
    "mandateId": "string",
    "amount": 0,
    "remarks": "string"
}

Request 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 POST '/api/v0/upi-mandate/execute' \
--header 'merchantAccessKey;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mandateId": "string",
    "amount": 0,
    "remarks": "string"
}'

Responses

🟢200Success
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object (OrderGetResponse) 
optional
orderId
string 
optional
The unique identifier for the order.
created
string <date-time>
optional
The timestamp indicating when the order was created.
lastModified
string <date-time>
optional
The timestamp indicating when the order was last modified.
merchantOrderId
string 
optional
The merchant-specific identifier for the order.
merchantIdentifierKey
string 
optional
The merchant's unique identifier key associated with the order.
amount
number 
optional
The total amount associated with the order.
currency
string 
optional
The currency in which the order amount is specified.
returnUrl
string 
optional
The URL to which the customer will be redirected after completing the payment.
notifyUrl
string 
optional
The URL where notifications regarding the order will be sent.
status
enum<string> 
optional
The current status of the order.
Allowed values:
CREATEDCHECKOUT_RENDEREDPAIDCANCELLEDATTEMPTEDEXPIREDPAYMENT_CONFIRMATION_PENDING
customerInfo
object (CustomerDetail) 
optional
Information about the customer associated with the order.
orderMessage
string 
optional
Additional message or information related to the order.
orderDate
string <date-time>
optional
The date when the order was placed.
customParameters
object 
optional
transactions
array[object (OrderTransactionResponse) {18}] 
optional
Details of transactions associated with the order.
merchantName
string 
optional
paymentDetail
object (OrderPaymentDetail) 
optional
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "orderId": "string",
        "created": "2019-08-24T14:15:22Z",
        "lastModified": "2019-08-24T14:15:22Z",
        "merchantOrderId": "string",
        "merchantIdentifierKey": "string",
        "amount": 0,
        "currency": "string",
        "returnUrl": "string",
        "notifyUrl": "string",
        "status": "CREATED",
        "customerInfo": {
            "firstName": "string",
            "lastName": "string",
            "address": {
                "streetName": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "zipcode": "string"
            },
            "email": "string",
            "phoneNumber": "string"
        },
        "orderMessage": "string",
        "orderDate": "2019-08-24T14:15:22Z",
        "customParameters": {
            "property1": "string",
            "property2": "string"
        },
        "transactions": [
            {
                "transactionId": "string",
                "created": "2019-08-24T14:15:22Z",
                "lastModified": "2019-08-24T14:15:22Z",
                "type": "SALE",
                "amount": 0,
                "currency": "string",
                "status": "CREATED",
                "paymentDetail": {
                    "paymentMode": "NET_BANKING",
                    "cardHolderName": "string",
                    "cardNumber": "string",
                    "expiry": "string",
                    "cardType": "CREDIT_CARD",
                    "cardSchemeType": "VISA",
                    "bankCode": "string",
                    "bankName": "string",
                    "accountNumber": "string",
                    "ifsc": "string"
                },
                "bankResponse": {
                    "terminalID": "string",
                    "bankTransactionId": "string"
                },
                "txnMessage": "string",
                "txnDate": "2019-08-24T14:15:22Z",
                "surcharge": 0,
                "surchargeGst": 0,
                "finalAmount": 0,
                "txnMsg": "string",
                "mdr": 0,
                "mdrGst": 0,
                "transactionAmount": 0
            }
        ],
        "merchantName": "string",
        "paymentDetail": {
            "accountNumber": "stringstr",
            "ifsc": "KKBK0000432"
        }
    }
}
Modified at 2025-07-05 12:41:45
Previous
Mandate Pre-debit Notification
Next
Mandate Debit Callback
Built with