Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. UPI Mandate
  • Payment Gateway Overview
  • Getting Started
  • Payment Methods
  • Integration
  • API Endpoints
  • APIs
    • Authorisation
      • Get Authorization Token
    • Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
      • Verify VPA
    • Refund
      • Refund
    • Settlement
      • Settlement Reporting
      • 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/Deferred Split Settlement
    • E-Commerce Plugins
    • Payment Button
    • Qr Code
      • Create Qr Code
      • Get QR Code
      • Search QR Code
      • createCustomer
      • searchCustomer
      • Cancel QR Code
    • UPI Mandate
      • Create UPI Mandate
        POST
      • Update UPI Mandate
        PATCH
      • Revoke UPI Mandate
        PATCH
      • Get UPI Mandate
        GET
      • UPI mandate create callback
        POST
      • Mandate Pre-debit Notification
        POST
      • Execute mandate debit
        POST
      • Mandate Debit callback
        POST
    • Payment Links
      • Payment Links Overview
      • Payment Link APIs
      • Payment Link
        • Create Payment Link
        • Get Payment Link Details
        • Delete Payment Link
      • Payment Link Webhook
        • Payment Link Webhook Request
  1. UPI Mandate

Mandate Pre-debit Notification

POST
/api/v0/upi-autopay/mandates/pre-debit-notification

Request

Body Params application/json
mandateId
string 
required
amount
number 
required
debitDate
string <date>
required
Example
{
    "mandateId": "string",
    "amount": 0,
    "debitDate": "2019-08-24"
}

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-autopay/mandates/pre-debit-notification' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mandateId": "string",
    "amount": 0,
    "debitDate": "2019-08-24"
}'

Responses

🟢200Success
application/json
Body
response_code
integer <int32>
optional
response_message
string 
optional
payload
object 
optional
mandateId
string 
required
predebitNotificationId
string 
required
status
string 
required
amount
string 
required
debitDate
string 
required
Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "mandateId": "string",
        "predebitNotificationId": "string",
        "status": "string",
        "amount": "string",
        "debitDate": "string"
    }
}
Previous
UPI mandate create callback
Next
Execute mandate debit
Built with