Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. UPI Mandate
  • EnKash Developer Portal Overview
  • Payment Gateway
    • Payment Gateway Overview
    • Payment Gateway Sign Up
    • Payment Methods
    • Supported Integrations
    • Payment Gateway APIs
    • Web Integration
    • Server to Server Integration
    • Test Card Details
    • Authorization
      • About Authorization
      • Get Authorization Token
    • Orders
      • About Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payments
      • About Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
    • Refunds
      • About Refund
      • Refund
    • Settlements
      • About Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlements
      • About Split Settlements
      • 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 Links
    • 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
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • B2B Invoicing
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
        • Webhook Send Purchase Order Response
        • Webhook Confirm Purchase Order Request
        • Webhook Confirm Purchase Order Response
        • Webhook Edit Purchase Order Request
        • Webhook Edit Purchase Order Response
        • Webhook Status Change Purchase Order Request
        • Webhook Status Change Purchase Order Response
    • Bill Payments
      • Bill Payments Overview
      • Get Authentication Token
      • Get BillerTypes
      • Get Billers
      • Fetch Bill
      • Create Bill API
      • Create Bill Without Bill Fetch
      • Bill Payment
      • Utility Bill Approval API
      • Get Utility Bill Status
      • Get Utility Bill by Reference Id
      • Get Utility Bills Detail
      • Bill Payment Webhook
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payout API Response Codes
    • Payouts Integration Steps
    • Encrypting and Decrypting Payload
    • Payouts Status Codes
    • Get Authentication Token
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Accounts Payable Management Tool
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
      • Create Bulk Vendors
      • Update Bulk Vendors
      • Get Beneficiaries (V1)
      • Get Beneficiaries
      • Change Vendor Status
      • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • validateInvoices
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • deleteCustomerByCustomerId
        • updateCustomer
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • Token Api
      • About Authorization
      • Token API
    • Expenses
    • Advance
  • Loyalty
    • Overview
    • Sign Up
    • Employee R&R
      • API Integration Guide
      • Common Fields passed in API requests
      • Token Api
        • Client Authentication
        • SSO LOGIN (Single Sign On)
      • Create And Allocate point
      • Bulk Create And Allocate Points
      • Get Card Account Details
      • Get Transaction details
      • List Users Details
      • Get User Card Details
    • Channel Incentives
      • Incentive Create And Allocate point
      • Reward Get Transaction details
      • Incentive Get User Details
    • Points Redemption
      • User Authentication
      • Get Cart for User
      • Search Catalog
      • Get Product Catalog Details
      • Get Product Configs (Denominations)
      • Add to cart
      • Update Cart
      • Create Order
      • Order Search
      • create order
      • Fetch Order Info by Partner order Reference id
    • Point Management APIs
      • Overview
      • Create Event
      • Get Event
      • Update Event
      • Allocate Coins
      • Get Balance
  • Card Management
    • EnKash Card Management Systems Overview
    • Cards We Issue
    • API Reference
    • VKYC
    • Developer Guide
    • Cards Integration Steps
    • Encryption / Decryption of API requests / Response
    • Encryption & Decryption Guide
    • Token Api
      • Partner auth Token
    • Gift Card
      • Create
      • Request Physical
      • Block
      • Replace
      • Get User Details
      • Get Transaction Details
      • Get All Transaction details
    • Meal Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Prepaid Cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Request Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Fuel_cards
      • Create
      • Load Balance
      • Replace
      • Block
      • Physical
      • Get User Card Details
      • Get Transaction Details
      • Get All Transaction details
    • Advance Card Feature
      • Create Card Account
      • Set Pin
      • Get Card Account Details
      • Generate Otp Card
      • View Card
      • Update Card Velocity Rules
      • Get Card Velocity Rules
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. UPI Mandate

Create UPI Mandate

POST
/api/v0/upi-autopay/mandates
Create UPI Mandate for customer in order to collect money

Request

Body Params application/json
referenceId
string 
required
amount
integer 
required
amountRule
string 
required
currency
string 
required
payer
object 
required
name
string 
required
vpa
string 
required
account
string 
required
accountValidation
boolean 
required
mandateName
string 
required
expiry
string <date-time>
required
blockFund
boolean 
required
recurrence
object 
required
period
string 
required
rule
string 
required
value
integer 
required
validity
object 
required
startAt
string <date-time>
required
endAt
string <date-time>
required
upiReferenceUrl
string 
optional
description
string 
optional
Example
{
  "referenceId": "TXN9876543",
  "amount": 2540,
  "amountRule": "EXACT | MAX",
  "currency": "INR",
  "payer": {
    "name": "John Doe",
    "vpa": "9876543210.prod@bank",
    "account": "0987654321",
    "accountValidation": false
  },
  "name": "Subscription Payment",
  "expiry": "2025-01-31 00:00:00",
  "blockFund": true,
  "recurrence": {
    "period": "onetime|daily|weekly|fortnightly|monthly|bimonthly|quarterly|halfyearly|yearly|aspresented",
    "rule": "ON | before | after",
    "value": 3
  },
  "validity": {
    "startAt": "2025-01-20 00:00:00",
    "endAt": "2025-01-30 00:00:00"
  },
  "upiReferenceUrl": "https://www.example.com/",
  "description": "Recurring Payment for Subscription"
}

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' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceId": "TXN9876543",
    "amount": 2540,
    "amountRule": "EXACT | MAX",
    "currency": "INR",
    "payer": {
        "name": "John Doe",
        "vpa": "9876543210.prod@bank",
        "account": "0987654321",
        "accountValidation": false
    },
    "name": "Subscription Payment",
    "expiry": "2025-01-31 00:00:00",
    "blockFund": true,
    "recurrence": {
        "period": "onetime|daily|weekly|fortnightly|monthly|bimonthly|quarterly|halfyearly|yearly|aspresented",
        "rule": "ON | before | after",
        "value": 3
    },
    "validity": {
        "startAt": "2025-01-20 00:00:00",
        "endAt": "2025-01-30 00:00:00"
    },
    "upiReferenceUrl": "https://www.example.com/",
    "description": "Recurring Payment for Subscription"
}'

Responses

🟢200OK
application/json
Body
umn
string 
required
referenceId
string 
required
mandateId
string 
required
amount
integer 
required
amountRule
string 
required
currency
string 
required
mcc
string 
required
payer
object 
required
name
string 
required
vpa
string 
required
account
string 
required
accountValidation
boolean 
required
name
string 
required
expiry
string <date-time>
required
blockFund
boolean 
required
recurrence
object 
required
period
string 
required
rule
string 
required
value
integer 
required
validity
object 
required
startAt
string <date-time>
optional
endAt
string <date-time>
required
upiReferenceUrl
string 
required
description
string 
required
upiPurposeCode
string 
required
upiResponseCode
string 
required
status
string 
required
createdOn
string <date-time>
required
Example
{
  "umn": "string",
  "referenceId": "string",
  "mandateId": "string",
  "amount": 0,
  "amountRule": "string",
  "currency": "string",
  "mcc": "string",
  "payer": {
    "name": "string",
    "vpa": "string",
    "account": "string",
    "accountValidation": true
  },
  "name": "string",
  "expiry": "2019-08-24T14:15:22Z",
  "blockFund": true,
  "recurrence": {
    "period": "string",
    "rule": "string",
    "value": 0
  },
  "validity": {
    "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-02-07 08:09:30
Previous
Cancel QR Code
Next
Update UPI Mandate
Built with