Pause Mandate

The API can be used to Pause an Active Mandate

📘

Note:

Only ACTIVE mandates can be paused.

Response Parameters

ParameterTypeDescription
mandate_idStringUnique Identifier for the mandate. Mandate id can be obtained from the List Mandate API response
mandate_statusStringStatus of the mandate. Will be PAUSED only if the mandate is at ACTIVE state earlier.
start_dateStringMandate start date in UNIX EPOCH timestamp (UTC timezone) format.
rule_typeStringMandate execution rule type ie, ON | BEFORE | AFTER
revokable_by_customerBooleanStates if mandate is revokable by the customer
response_messageStringRepresents the action performed. Ex: Pause mandate is scheduled, 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.
max_amountNumberMax amount of mandate set while creating a mandate
mandate_typeStringMandate type: MANDATE(Cards) or EMANDATE (others)
mandate_tokenStringUnique Token provided by Juspay after mandate creation.
block_fundBooleanTrue/False based on the value passed during mandate creation
last_activated_atStringThe time at which mandate moved to ACTIVE state.
frequencyStringFrequency of mandate set. By default ASPRESENTED
end_dateStringMandate end date in UNIX EPOCH timestamp (UTC timezone) format.
amount_ruleStringVARIABLE or FIXED
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!