Body
Resume Mandate API
The API can be used to resume the paused mandates
Note
Resume operation can be done only on Paused mandates.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/mandates/{mandate_id}
Production Link
POST
https://api.juspay.in/mandates/{mandate_id}
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
string
Required
The username that a merchant holds at Juspay.
Content-Type
string
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Path Params
mandate_id
*
String
Mandatory
Merchant Id
Example:- 7KKT3yu3LcQjskY5F4moS5M
Parameters
command
*
string
Required
To be set as “resume”, to resume an existing paused mandate.
resume_date
string
[Optional] Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate needs to be set active. Default value will be the current date.
200 : Success
Response Body
start_date
string
Mandate start date in UNIX EPOCH timestamp (UTC timezone) format.
rule_type
string
Mandate execution rule type
i.e. ON | BEFORE | AFTER
revokable_by_customer
boolean
States if mandate is revokable by the customer.
response_message
string
Represents the action performed. Ex: "Mandate is Resumed".
pause_end_date
string
Mandate pause end date in UNIX EPOCH timestamp (UTC timezone) format.
max_amount
integer
Max amount of mandate set while creating a mandate.
mandate_type
string
Mandate type: MANDATE (Cards) or EMANDATE (others)
mandate_token
string
Unique Token provided by Juspay after mandate creation.
mandate_status
string
Status of the mandate. Will be ACTIVE only if the previous state was PAUSED.
mandate_id
string
Unique Identifier for the mandate generated and sent by Juspay after mandate creation. Mandate ID can be obtained from the List Mandate API response.
last_activated_at
string
The time at which mandate last moved to ACTIVE state.
frequency
string
Frequency of mandate set. By default ASPRESENTED
end_date
string
Mandate end date in UNIX EPOCH timestamp (UTC timezone) format when a mandate will move to EXPIRED state.
block_fund
boolean
True/False based on the value passed during mandate creation
amount_rule
string
VARIABLE or FIXED
400 : Invalid Input data
Response Body
status
string
Invalid Request
error_message
string
Mandate Not in REVOKED State. Resume mandate not allowed
error_code
string
BAD_REQUEST