- Payment Gateway Overview
- Payment Gateway Sign Up
- Payment Methods
- Supported Integrations
- Payment Gateway APIs
- Web Integration
- Server to Server Integration
- Test Card Details
- Authorization
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
Update UPI Mandate
PATCH
/api/v0/upi-autopay/mandates/{mandateId}
Request
Path Params
mandateId
string
required
Body Params application/json
amount
number
optional
expiry
string <date-time>
optional
validity
object
optional
endAt
string <date-time>
required
description
string
optional
pausePeriod
object
optional
startAt
string <date-time>
required
endAt
string <date-time>
required
Example
{
"referenceId": "TMUM9876543",
"amount": 2540,
"expireAt": "2025-01-31 00:00:00",
"validity": {
"endAt": "2025-01-30 00:00:00"
},
"description": "Updated Mandate Request"
}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 PATCH '/api/v0/upi-autopay/mandates/' \
--header 'Content-Type: application/json' \
--data-raw '{
"referenceId": "TMUM9876543",
"amount": 2540,
"expireAt": "2025-01-31 00:00:00",
"validity": {
"endAt": "2025-01-30 00:00:00"
},
"description": "Updated Mandate Request"
}'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>
required
endAt
string <date-time>
required
pausePeriod
object
required
startAt
string <date-time>
required
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": "XYZ987",
"referenceId": "TXN6543210",
"mandateTransactionId": "ENKA00001234",
"amount": 1722,
"amountRule": "EXACT | MAX",
"currency": "usd",
"payee": {
"vpa": "merchant@abc",
"name": "ABC Pvt. Ltd.",
"mcc": "1234"
},
"payer": {
"name": "Jane Smith",
"vpa": "1234567890.prod@bank",
"account": "5678901234",
"accountValidation": true
},
"name": "Subscription Payment",
"expireAt": 1823418099,
"blockFund": true,
"revokeableByPayer": true,
"recurrence": {
"period": "ONE_TIME | DAILY | WEEKLY | FORTNIGHTLY | MONTHLY | BIMONTHLY | QUARTERLY | HALF_YEARLY | YEARLY | AS_PRESENTED",
"rule": "after",
"value": 3
},
"validity": {
"startAt": 1823418099,
"endAt": 1924519100
},
"pausePeriod": {
"start_at": 1722317078,
"end_at": 1722317078
},
"upiReferenceUrl": "https://www.example.com/",
"description": "Automated Recurring Mandate",
"upiPurposeCode": "10",
"upiResponseCode": "99",
"status": "pending",
"createdAt": 1823418099
}Modified at 2025-02-07 08:09:02