Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Pause Mandate

The API can be used to Pause an Active Mandate

📘

Note:

Only ACTIVE mandates can be paused.

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:
  Mandate Object parameters:     (click to view)
FieldTypeDescription
mandate_idStringMandate 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_tokenStringMandate 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_statusStringStatus of the mandate. Will be PAUSED only if the previous state was ACTIVE. Other possible states are:
/ CREATED / REVOKED / FAILURE / EXPIRED /    (ENUM format)
mandate_typeStringEMANDATE in case of UPI/NB/Wallet payment
MANDATE in case of Card payment
max_amountStringMaximum amount of mandate set while creating a mandate. Mandatory only if mandate.amount_rule = VARIABLE.
currencyStringISO string of the currency. Default value: INR (Indian Rupee). Among other accepted values are EUR, USD, GBP.
last_activated_atStringThe time at which mandate last moved to ACTIVE state.
frequencyStringDefines the frequency of mandate execution, or how often a customer should be charged.
 Description for mandate.frequency
Possible values (ENUM format):
ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTED
Default:     ASPRESENTED
Check here for additional rules on this value.
amount_ruleStringData 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_dateStringMandate start date in UNIX EPOCH timestamp (UTC timezone) format. Mandatory only for UPI Mandate.
end_dateStringMandate 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_fundBooleantrue/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_valueIntegerDetermines the day of week or month that a mandate will be executed, depending on the mandate.frequency.
 Description for rule.value
Possible values (Integer format):
1-7when frequency is WEEKLY. In weekly, serial numbers start from Monday. Monday represents 1 and Sunday represents 7.
1-16when frequency is FORTNIGHTLY. This mandate is executed twice a month. First day of the month is represented by value ‘1’ and ends with ‘15’ on 15th day of the month. Then again starts with ‘1’ for 16th of the month and ends with the last day of the month.
1-31when frequency is MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, orYEARLY.
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_typeStringMandate 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_customerBooleanIf 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.

FieldTypeDescription
response_messageStringRepresents the action performed. Example: "Mandate is Paused."
pause_start_dateStringMandate pause start date in UNIX EPOCH timestamp (UTC timezone) format.
pause_end_dateStringMandate pause end date in UNIX EPOCH timestamp (UTC timezone) format.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!