---
page_title: Amend API
product: lotuspay
platform: web
page_source: https://docs.juspay.io/lotuspay/web/mandate-management-apis/amend-api
openapi: https://docs.juspay.io/api/swagger?document=https%3A%2F%2Fdocs.juspay.io%2Flotuspay%2Fweb%2Fmandate-management-apis%2Famend-api
llms_txt: https://docs.juspay.io/llms.txt
product_llms_txt: https://docs.juspay.io/lotuspay/llms.txt
---

## API Version: default


# Amend API



To initiate an amend request on any mandate, the merchant can either use UMRN or Mandate id_token. The request type will be PATCH and the attributes to be amended should be provided in the request body using JSON format.

**Pass in the body of request as JSON to specify which all attributes need to be amended. Below table shows possible attributes (key) which can be amended for a mandate.** 

**Note : Default expiry of the generated auth link will be 30min from the time of creation.** **Validations for amend request to be done at LotusPay end:** 

* The mandate should be in active state, then only amend request can be initiated on it.
* At Least one out of the given four keys should be there in request to apply for a mandate amendment.
* If a mandate has a collection_amount, only the collection_amount can be amended, and if it has a maximum_amount, only the maximum_amount can be amended. Reverse is not possible.
* Final collection date should not exceed 40 years from the date of mandate.
* Final collection date cannot be a past date.
* There should not be any pending Amend/Pause/Resume on the same mandate.
  
  
  | Key | Requirement | Value | Description |
  |---|---|---|---|
  | frequency | Optional | ALP NUM | Regularity with which instructions are to be created and processed. Frequency codes currently accepted are:  Adho     =>   Adhoc,  INDA     =>   Intra Day,  DAIL     =>   Daily, Week    =>   Weekly,  MNTH   =>   Monthly,  QURT   =>   Quarterly,  MIAN    =>   Semi annually,  YEAR   =>    Yearly, BIMN    =>    Bi-Monthly,  |
  | collection_amount | Optional | Num as String | Amount to be debited from the debtor’s account in each instruction.  If the amount passed is a whole number then that will be treated in paisa. If the amount passed is in decimal then that will be treated in rupees.  For example: “1000” signifies 10 rupees and “1000.00” signifies 1000 rupees. |
  | maximum_amount | Optional | NUM as String | Maximum amount that can be debited from the debtor's account in each instruction.  If the amount passed is a whole number then that will be treated in paisa. If the amount passed is in decimal then that will be treated in rupees.  For example: “1000” signifies 10 rupees and “1000.00” signifies 1000 rupees. |
  | final_collection_date | Optional | ISO Date | Date of the Final collection of a direct debit as per the mandate. This field is in ISO Date Format  Ex: final_collection_date:  2024-09-17  |
  
  
  Child arguments for redirect:
  
  
  | Key | Requirement | Description |
  |---|---|---|
  | auth_mode | Optional | Default auth mode which needs to be used during the authentication.  If not provided then all the available auth_modes will be shown to the customer. |
  | return_url | Optional | URL on which LotusPay will redirect users after completion of the authentication process. |## Endpoints:
- Sandbox: https://api-test.lotuspay.com/api/mandates/amend?umrn=<UMRN>

- Production: https://api.lotuspay.com/api/mandates/amend?umrn=<UMRN>

## Request Type: 
PATCH

## Content-Type: 
application/json

## Authorization:

#### Basic Auth:
Auth example
- Value:  c2tfdGVzdF82MXFIUURuYTgzMWNOTm9vb29uRzFlQWlEOg==
- Tags: Required
## Sample Code Snippets:
### Code Snippets:

#### Request Using Mandate ID Code Snippet:

```request using mandate id
curl --location --request PATCH 'https://api-test.lotuspay.com/api/mandates/amend?mandate_id=MD0086WWA8U5CH' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic c2tfdGVzdF82MXFIUURuYTgzMWNOTm9vb29uRzFlQWlEOg==' \
--data '{
    "final_collection_date": "2032-11-12",
    "redirect": {
        "auth_mode": "debitcard",
        "return_url": "https://lotuspay.com"
    }
}'
```

#### Request Using UMRN Code Snippet:

```request using umrn
curl --location --request PATCH 'https://api-test.lotuspay.com/api/mandates/amend?umrn=HDFC000012345678' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic c2tfdGVzdF82MXFIUURuYTgzMWNOTm9vb29uRzFlQWlEOg==' \
--data '{
    "final_collection_date": "2032-11-12",
    "redirect": {
        "auth_mode": "debitcard",
        "return_url": "https://lotuspay.com"
    }
}'
```

### Sample Request and Response:

#### Response:
```plaintext
{
    "status": "Request received",
    "request_id": "TURsM2QqeFl0TXlKcEI0NW03SjQ=",
    "request_expiry_time": "2026-05-18T18:35:24.166731271",
    "message": "Ask customer to authorize it on given authorization link",
    "auth_link": "https://test.lotuspay.com/v2/mandates/amend/auth?request_id=TURsM2QqeFl0TXlKcEI0NW03SjQ=&client_secret=mndt_client_secret_rf8RCz7fsX81111111111111"
}
```

## API Responses: