1. Introduction

Scenarios where in the eMandate set up created in the past may have a need to modify it in future. Modify mandate API give the flexibility to make necessary changes and manage customer expectation at merchant's end.

Modify mandate essentially allows to manage mandate certain attributes depending upon the networks. BillDesk has defined the below attributes based on networks.

Through this action, few mandate attributes can be modified (as mentioned below), the customer is required to complete an additional AFA using the payment method linked with the mandate to approve the modification process.

2. API Orchestration

The orchestration of the API/s workflow has been explained below:

API Reference	Description
Modify Mandate	Merchant can modify the mandate using the mercid, mandate id.
Update Mandate	Merchant needs to call update mandate API after calling the Modify Mandate API.

🚧
Note
When the payment method changes, the attributes merchant can modify also changes. Below table specifies the attributes.

Payment Method	Applicable Attributes for Modification
card - RuPay card	• end_date. • amount.
card • Visa • Mastercard • American Express • Diners	• end_date. • amount. • frequency. • amount_type.
upi	• end_date. • amount.

Payment Method

Applicable Attributes for Modification

card - RuPay card

• end_date.
• amount.

card

• Visa
• Mastercard
• American Express
• Diners

• end_date.
• amount.
• frequency.
• amount_type.

upi

• end_date.
• amount.

2.1 Modify Mandate Request Attributes

Here are some of the attributes required to initiate retrieve mandate request. For more details click here

Attribute	Description
mandateid	Unique mandateid created by BillDesk.
mercid	Unique identifier as defined by BillDesk for each merchant.
end_date	Subscription end date in `yyyy-mm-dd` format. Note * Value should be greater than current date (IST) & if mandate end date is until cancelled, the value to set as 2050-12-31.
amount_type	Whether subscription amount is `fixed` or `maximum` limit. • `maximum` subscription recurring can be charged upto the maximum amount. • `fixed` to be set for fixed subscription amount.
amount	Subscription amount in two decimals, eg. 2400.00
frequency	Subscription debit frequency. Accepted values are: • `week` weekly • `mnth` monthly • `bimn` bi-monthly • `qurt` quarterly • `bian` bi-annually • `year`yearly • `adho` adhoc
payment_method_type	Payment method type.