Body
Mandate Status Check API
A merchant can all this API to get the status of a particular mandate setup with us. When the merchant calls this API, we will sync with PGs to get the latest Mandate Status value and update back in our response, or share the latest Mandate Status stored with us in DB.
Note
We will only sync with a few PGs for now for the updated Mandate Status, for others we will provide with the latest Mandate Status stored with us.
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
*
required
Base64 Encoded Username:Password
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
String
Mandatory
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
Mandate Id
Example:- 7KKTSsVLcQjskY5F4moS5M
Request Schema: application/json
Basic Parameters
command
*
String
Mandatory
To be set as "check_status", to check status of the mandate
200 : Success
Response Body
order_id
String
Order id passed by the merchant
frequency
String
Frequency value passed for the mandate
end_date
String
Expiry date for the mandate. This will be in epoch format.
status
String
Current status of the mandate
activated_at
String
The date when mandate was activated.
last_activated_at
String
The date when mandate last received information about becoming active.
amount_rule
String
Amount rule passed for the mandate
last_updated
String
Last time status of the mandate was updated
start_date
String
Date when mandate was started. This will be in epoch format.
mandate_debit_token
String
deprecated
customer_id
String
The customer id for which the mandate has been set up
mandate_id
String
value of the mandate id that is being checked.
block_fund
String
if the mandate has blocked fund or not.
currency
String
Currency in which the amount will be debited for the mandate
max_amount
String
Max amount value for the mandate
mandate_token
String
Deprecated
revokable_by_customer
Boolean
If the mandate is revokable by customer or not
payment_info
Nested Json
Contains payment details via which payment was made.
mandate_type
String
Type of mandate - Mandate or EMandate