Body
Revoke Mandate API
Use this API to revoke/cancel an ACTIVE mandate.
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
Required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
string
Required
Merchant ID which would have been issues while registering with Juspay
Example:- 7SucJZ2PCyoGY5vvW8Xa26
Content-Type
*
String
Required
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
Required
Mandate Id
Parameters
command
*
string
Required
To be set as revoke, to revoke an existing mandate.
should_do_implicit_revoke
String
Optional
This parameter should be send, if we want to revoke Mandate at Juspay’s end still if Gateway is unable to revoke at their end. We will try to revoke mandate at gateway’s end, even if it fails, we will mark it failed at Juspay’s end.
200 : Success
Response Body
mandate_status
string
REVOKED
mandate_id
string
7SucJZ2PCyoGY5vvW8Xa26
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