Body
Pause Mandate
The API can be used to Pause an Active Mandate. Only ACTIVE mandates can be paused.
Request
Response
API Endpoints
Production Link
POST
https://api.juspay.in/mandates/{mandate_id}
Authorization Header
Basic Auth
*
Base64 encoded Username:Password
Required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
string
Required
The Username that a merchant holds at Juspay.
Example:-
merchant-id
Content-Type
string
application/x-www-form-urlencoded
Parameters
command
string
To be set as "pause", to pause an existing active mandate.
Example:-
pause
pause_start_date
string
Date in UNIX EPOCH timestamp (UTC timezone) format, when the mandate will be paused. Default value can be the current date.
Example:-
1664200815
pause_end_date
string
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.
Example:-
1664546405
200 : Success
Response Body
start_date
string
1659312000
rule_type
string
ON
revokable_by_customer
boolean
true
response_message
string
Mandate is Paused.
pause_start_date
string
2022-09-26T11:47:01Z
pause_end_date
string
2022-09-30T00:00:00Z
max_amount
integer
100
mandate_type
string
EMANDATE
mandate_token
string
42040d2b1d8e41k4jd9q40de80988357e
mandate_status
string
PAUSED
mandate_id
string
gksEbj93j24Z5Cbw4MWUa
last_activated_at
string
2022-09-26T11:47:01Z
frequency
string
ASPRESENTED
end_date
string
1690848000
block_fund
boolean
amount_rule
string
VARIABLE
400 : Invalid Input data
Response Body
status
string
invalid_request_error
error_message
string
Mandate not found
error_code
string
Mandate not found
401 : Authentication Failed
Response Body
status
string
error
error_code
string
access_denied
error_message
string
Invalid Authentication