post https://sandbox.juspay.in/mandates/
The API can be used to resume a paused mandate.
Note:
Resume operation can be done only on Paused mandates.
⭣The response consists of Mandate Object parameters, response_message, and pause start/end date parameters:
(click to open table) Each parameter in tables is listed below:
(click to open table) Each parameter in tables is listed below:
Mandate Object parameters: (click to view)
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| mandate_id | String | Mandate ID is a unique identifier generated and sent by Juspay after mandate creation. mandate_id can be obtained from the List Mandate API response | ||||||
| mandate_token | String | Mandate token is a unique identifier generated and sent by Juspay after mandate creation for one-time use. Allows a charge without a 2nd factor. | ||||||
| mandate_status | String | Status of the mandate. Will be ACTIVE only if the previous state was PAUSED. Other possible states are: / CREATED / REVOKED / FAILURE / EXPIRED / (ENUM format) | ||||||
| mandate_type | String | EMANDATE in case of UPI/NB/Wallet payment MANDATE in case of Card payment | ||||||
| max_amount | String | Maximum amount of mandate set while creating a mandate. Mandatory only if mandate.amount_rule = VARIABLE. | ||||||
| currency | String | ISO string of the currency. Default value: INR (Indian Rupee). Among other accepted values are EUR, USD, GBP. | ||||||
| last_activated_at | String | The time at which mandate last moved to ACTIVE state. | ||||||
| frequency | String | Defines the frequency of mandate execution, or how often a customer should be charged.Description for mandate.frequencyPossible values (ENUM format):ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTEDDefault: ASPRESENTEDCheck here for additional rules on this value. | ||||||
| amount_rule | String | Data type ENUM Possible values: FIXED, VARIABLE. By Default, it is considered as VARIABLE. In case of FIXED, max amount will be equal to amount | ||||||
| start_date | String | Mandate start date in UNIX EPOCH timestamp (UTC timezone) format. Mandatory only for UPI Mandate. | ||||||
| end_date | String | Mandate end date in UNIX EPOCH timestamp (UTC timezone) format, when a mandate will move to EXPIRED state, and recurring mandate execution will not be allowed. Mandatory only for UPI Mandate. | ||||||
| block_fund | Boolean | true/false based on the value passed during mandate creation. Set to true if funds have to be blocked while a mandate is being created. Should be true for ONETIME and false for Recurring. By default, value will be true for ONETIME and false for Recurring. | ||||||
| rule_value | Integer | Determines the day of week or month that a mandate will be executed, depending on the mandate.frequency.Description for rule.valuePossible values (Integer format):
Not required when frequency is ONETIME, DAILY, or ASPRESENTED. For Razorpay, rule_value will be considered as the last date of the week/month/year. For Paytm, rule_value will be considered as today’s date/day.Check here for additional rules on this value. | ||||||
| rule_type | String | Mandate execution rule type i.e. ON / BEFORE / AFTER For Razorpay, rule_type will be updated to BEFORE. For Paytm, rule_type will be updated to AFTER |
| revokable_by_customer | Boolean | If false, the mandate cannot be revoked by the customer once set. It should be true for Recurring and true/false for ONETIME. By default, value will be true. |
| Field | Type | Description |
|---|---|---|
| response_message | String | Represents the action performed. Example: "Mandate is Resumed." |
| pause_start_date | String | Mandate pause start date in UNIX EPOCH timestamp (UTC timezone) format. |
| pause_end_date | String | Mandate pause end date in UNIX EPOCH timestamp (UTC timezone) format. |