List Mandate API
A merchant can call this API to get the list of all the mandates that a customer has with them. The list will have the revoked, expired and failed mandates too.
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Pass the date in YYYY-MM-DD format.
Note: If a version is provided, the response will include data corresponding to that specific version date.
It is recommended not to enforce strict validation on the entire response on the merchant's side to allow for future key additions.
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
Customer ID which represents the user uniquely. Eithercustomer_id or object_reference_id can be used to retrieve stored card details.
Object_reference_id: An ID maintained at merchant’s end for each customer.Customer_id: An ID(idfield of Create customer API response) created by Juspay for eachObject_reference_idduring the Create Customer API call.
Example:- cst_lz7zmpemoo5okgav
Total Mandate records set against customer_id
Number of Mandate records to be skipped while fetching the list of Mandate records against a customer_id
Default value is 0
“list”
An array of Mandate Object
Mandate status ENUM. CREATED | ACTIVE | PAUSED | REVOKED | FAILURE | EXPIRED
See Appendix for status mapping.
It contains the payment instrument details using which the mandate was created
Payment method type used at the time of creating a mandate
Payment method used at the time of creating a mandate
Max amount of mandate set while creating a mandate
Mandate type: MANDATE(Cards) or EMANDATE (Rest all)
Mandate id sent by Juspay after mandate creation.
Currency set while creating a mandate
Number of Mandate records to be fetched against a customer_id
Provides the reason for the error
Example:- Sample value: Customer not found
Error status
Example:- Sample value:ERROR
Specifies the Error code
Example:- Sample value:INVALID_REQUEST
Additional information on the error message
Error message can be displayed to the user
Example:- Sample value:Cannot process your request as customer not found.
Detailed info on the error
Example:- Sample value:Customer not found.
category of the error
Example:- Sample value:USER_ERROR