Body
Pause Mandate
The API can be used to Pause an Active Mandate
Note
Only ACTIVE mandates can be paused.
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
Recommended
Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.
Note
Passing this value will help us route efficiently at network level.
Example:- x-merchantid: testaccount
Content-Type
string
application/x-www-form-urlencoded
Path Params
mandate_id
*
String
Mandatory
Mandate Id
Example:- 7KKTSsVLcQjskY5F4moS5M
Parameters
command
*
string
Required
To be set as "pause", to pause an existing active mandate.
pause_start_date
string
Max Length :10
Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate will be paused. Default value can be the current date.
pause_end_date
string
Max Length :10
Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate status will be automatically changed to ACTIVE. Default value can be set to mandate_end_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 ie, ON | BEFORE | AFTER
revokable_by_customer
boolean
States if mandate is revokable by the customer
response_message
string
Represents the action performed. Ex: Pause mandate is scheduled, Mandate is Paused.
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.
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 PAUSED only if the mandate is at ACTIVE state earlier.
mandate_id
string
Unique Identifier for the mandate. Mandate id can be obtained from the List Mandate API response
last_activated_at
string
The time at which mandate 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.
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
Mandate Not Found
JSON
status
String
error_message
String
error_code
String
Invalid Status Change Request
JSON
user_message
String
type
String
session_id
String
message
String
code
String
Invalid Pause Start Date
JSON
user_message
String
type
String
session_id
String
message
String
code
String
Invalid Pause End Date
JSON
user_message
String
type
String
session_id
String
message
String
code
String
Pause Start Date >= Pause End Date
JSON
user_message
String
type
String
session_id
String
message
String
code
String
401 : Authentication Failed
Response Body
status
string
error
error_code
string
access_denied
error_message
string
Invalid Authentication
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 Pause on failure/inactive mandate
| 400
| Bad Request
| {"user_message":"Pause action not allowed.","message":"Mandate is in FAILURE state.","error_info":{"user_message":"Mandate is in FAILURE state.","developer_message":"Pause 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"}}
|
"Performing Pause on CREATED mandate/ pending transaction
| 400
| Bad Request
| {"user_message":"Pause action not allowed.","message":"Mandate is in CREATED state.","error_info":{"user_message":"Mandate is in CREATED state.","developer_message":"Pause action not allowed.","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"}}
|
4 columns 8 rows