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==
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.
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
Customer Id
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.
Mandate start date in UNIX EPOCH timestamp (UTC timezone) format.
Rule value
Rule type ON | BEFORE | AFTER
Revokable by customer : true or false
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
Payer VPA used during setting up mandate
Max amount of mandate set while creating a mandate
Mandate type: MANDATE(Cards) or EMANDATE (Rest all)
Mandate token sent by Juspay after mandate creation.
Mandate id sent by Juspay after mandate creation.
Frequency of mandate set. By default ASPRESENTED
Mandate end date in UNIX EPOCH timestamp (UTC timezone) format.
Currency set while creating a mandate
Block fund is true or false
Amount rule : VARIABLE or FIXED
Number of Mandate records to be fetched against a customer_id
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
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.
Revokable by customer : true or false
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
IFSC Code of the bank.
Account holder name.
Bank name
Bank account number
Max amount of mandate set while creating a mandate
Mandate type: MANDATE(Cards) or EMANDATE (Rest all)
Mandate token sent by Juspay after mandate creation.
Mandate id sent by Juspay after mandate creation.
Frequency of mandate set. By default ASPRESENTED
Currency set while creating a mandate
Block fund is true or false
Amount rule : VARIABLE or FIXED
Time stamp of mandate activation
Number of Mandate records to be fetched against a customer_id
ERROR
INVALID_REQUEST
Customer not found