- Explore Our Product Suite
- Payment Gateway
- Payment Gateway Overview
- Getting Started
- Payment Methods
- Integration
- API Endpoints
- APIs
- Authorisation
- Order
- Payment
- Refund
- Settlement
- Split Settlement
- E-Commerce Plugins
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Authorisation
- Payouts
- Prepaid Cards
- About Prepaid Card
- Key Capabilities
- Getting Started
- APIs
- API Access & Authorization
- Encryption & Decryption Guide
- Auth Token
- Create Card Account
- Create Gift Card
- Create Prepaid Card
- Set Card PIN
- Load Card Balance
- Get Card Account Details
- Generate Card OTP
- View Card Details
- Card Usage Controls
- Get Card Usage Limits
- Request Card Replacement
- Block Card
- Order Physical Card
- Get Card Details
- Get Transaction Details
- Get All Transaction details
- Bharat Connect (BBPS)
- About Bharat Connect
- Invoice Payments
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- 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
- Accounts Payable
- Account Receivable
- Expense Management
- Rewards & Incentives
- Verification Suite
Create UPI Mandate
POST
/api/v0/upi-mandate
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-mandate' \
--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"
}