JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Resume Mandate API

The API can be used to resume the paused mandates

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}

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      Content-Type
                      
                      

string

application/x-www-form-urlencoded

                      mandate_id
                      *
                      

String

Mandatory

Merchant Id

Example:- 7KKT3yu3LcQjskY5F4moS5M

Body

                      command
                      *
                      

string

Required

To be set as “resume”, to resume an existing paused mandate.

                      resume_date
                      
                      

string

Max Length :10

[Optional] Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate needs to be set active. Default value will be the current date.

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

Response Body

                      status
                      
                      

string

Invalid Request

                      error_message
                      
                      

string

Mandate Not in REVOKED State. Resume mandate not allowed

                      error_code
                      
                      

string

BAD_REQUEST

Error Codes

Scroll inside to view more

Scenario	Error Code	Description	Sample Response
Invalid Mandate ID	400	Bad Request	{"error_message":"Mandate not found","status":"invalid_request_error","error_code":"Mandate not found","error_info":{"user_message":"Cannot process your request as mandate not found.","developer_message":"Mandate not found for customer.","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"}}
Performing resume on REVOKED mandate	400	Bad Request	{"user_message":"Resume action not allowed.","message":"Mandate is in REVOKED state.","error_info":{"user_message":"Mandate is in REVOKED state.","developer_message":"Resume action not allowed.","code":"INVALID_INPUT"},"type":"INVALID_REQUEST_ERROR","code":"INVALID_REQUEST"}
Invalid API Key	401	Unauthorized	{"status":"error","error_code":"access_denied","error_info":{"user_message":"Unauthorized.","developer_message":"Invalid API Key. Please pass a valid and active api key.","code":"UNAUTHORIZED","category":"USER_ERROR"}}
Passing an invalid URL	404	Not Found
Not passing 'command' field	400	Bad Request	{"error_message":"Bad request.","status":"ERROR","error_code":"Bad request.","error_info":{"user_message":"Bad request.","fields":[{"field_name":"command","reason":"Field required but not passed."}],"developer_message":"Failed while parsing your request.","code":"MISSING_MANDATORY_PARAMETER","category":"USER_ERROR"}}
Passing Invalid resume date	400	Bad Request	{"user_message":"Please pass valid resume_date.","message":"Invalid resume_date.","error_info":{"user_message":"Invalid resume_date.","developer_message":"Please pass valid resume_date.","code":"INVALID_INPUT"},"type":"INVALID_REQUEST_ERROR","code":"INVALID_REQUEST"}
Passing Invalid 'command' value	400	Bad Request	{"error_message":"Invalid command","status":"Invalid Request","error_code":"bad_request","error_info":{"user_message":"Invalid command. Please check your request.","fields":[{"field_name":"command","reason":"Invalid value."}],"developer_message":"Invalid command. Please pass valid command in request.","code":"INVALID_INPUT","category":"USER_ERROR"}}
Performing Resume on an CREATED mandate	400	Bad Request	{"user_message":"Resume action not allowed.","message":"Mandate is in CREATED state.","error_info":{"user_message":"Mandate is in CREATED state.","developer_message":"Resume action not allowed.","code":"INVALID_INPUT"},"type":"INVALID_REQUEST_ERROR","code":"INVALID_REQUEST"}
Performing Resume on FAILED mandate	400	Bad Request	{"user_message":"Resume action not allowed.","message":"Mandate is in FAILURE state.","error_info":{"user_message":"Mandate is in FAILURE state.","developer_message":"Resume action not allowed.","code":"INVALID_INPUT"},"type":"INVALID_REQUEST_ERROR","code":"INVALID_REQUEST"}

Have questions?
Need help? Contact support
LLM? Read llms.txt