--- page_title: List Mandate API product: Express Checkout API page_source: https://juspay.io/eu/docs/ec-api-eu/docs/mandates/list-mandate-api openapi: https://juspay.io/eu/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Feu%2Fdocs%2Fec-api-eu%2Fdocs%2Fmandates%2Flist-mandate-api llms_txt: https://juspay.io/eu/docs/llms.txt product_llms_txt: https://juspay.io/eu/docs/ec-api-eu/llms.txt --- ## API Version: default # 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.## Endpoints: - Sandbox: https://sandbox.juspay.io/customers/{customer_id}/mandates - Production: https://api.juspay.io/customers/{customer_id}/mandates ## Request Type: GET ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded Username:Password, Mandatory ## Headers: #### version: 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. - Tags: String, Mandatory #### x-merchantid: Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive. > **Note** > Passing this value will help us route efficiently at network level. - Value: x-merchantid: testaccount - Tags: String, Recommended ## Sample Code Snippets: ### Sample Request: #### Request Code Snippet: ```request curl -X GET 'https://api.juspay.in/customers/:customer_id/mandates' \ -H 'Authorization: Basic ' \ -H 'version:2023-06-30 ``` ### Sample Response: #### 200 - Success: ```json { "total": 2, "offset": 0, "object": "list", "count": 2, "list": [ { "status": "ACTIVE", "payment_info": { "payment_method_type": "CARD", "payment_method": "MASTERCARD", "card": { "using_saved_card": true, "saved_to_locker": true, "name_on_card": "Shyam Sundar", "expiry_year": "2025", "expiry_month": "12", "card_type": "CREDIT", "card_issuer": "JP MORGAN", "card_isin": "545721", "card_brand": "MASTERCARD" }, "auth_type": "THREE_DS" }, "max_amount": 1000, "mandate_type": "MANDATE", "mandate_id": "ns3UFqGKHL*****XDE67", "mandate_debit_token": "tkn_98042ee*****1fdfbc", "currency": "SGD" } ] } ``` #### 400 - Bad Request: ```plaintext { "error_message": "Customer not found", "status": "ERROR", "error_code": "INVALID_REQUEST", "error_info": { "user_message": "Cannot process your request as customer not found.", "developer_message": "Customer not found.", "code": "RESOURCE_NOT_FOUND", "category": "USER_ERROR" }, "status_id": 40 } ``` ## Path Parameters: #### customer_id: Customer ID which represents the user uniquely. Either`customer_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(`id`field of Create customer API response) created by Juspay for each `Object_reference_id` during the Create Customer API call. - Value: Example:- cst_lz7zmpemoo5okgav - Tags: String, Mandatory ## API Responses: ### 200: #### Card: - Value: - **Total**: - Description: Total Mandate records set against customer_id - Tags: Integer - **Offset**: - Description: Number of Mandate records to be skipped while fetching the list of Mandate records against a customer_idDefault value is 0 - Tags: Integer - **Object**: - Description: “list” - Tags: String - **List**: - Description: An array of Mandate Object - Value: - **Status**: - Description: Mandate status ENUM. CREATED | ACTIVE | PAUSED | REVOKED | FAILURE | EXPIREDSee Appendix for status mapping. - Tags: String - **Payment_info**: - Description: It contains the payment instrument details using which the mandate was created - Value: - **Payment_method_type**: - Description: Payment method type used at the time of creating a mandate - Tags: String - **Payment_method**: - Description: Payment method used at the time of creating a mandate - Tags: String - **Card**: - Value: - **Using_saved_card**: - Tags: Boolean - **Saved_to_locker**: - Tags: boolean - **Name_on_card**: - Tags: String - **Expiry_year**: - Tags: String - **Expiry_month**: - Tags: String - **Card_type**: - Tags: String - **Card_issuer**: - Tags: String - **Card_isin**: - Tags: String - **Card_brand**: - Tags: String - Tags: object - **Auth_type**: - Tags: String - Tags: object - **Max_amount**: - Description: Max amount of mandate set while creating a mandate - Tags: Integer - **Mandate_type**: - Description: Mandate type: MANDATE(Cards) or EMANDATE (Rest all) - Tags: String - **Mandate_debit_token**: - Tags: String - **Mandate_id**: - Description: Mandate id sent by Juspay after mandate creation. - Tags: String - **Currency**: - Description: Currency set while creating a mandate - Tags: String - Tags: Array of objects - **Count**: - Description: Number of Mandate records to be fetched against a customer_id - Tags: Integer - Tags: JSON ### 400: #### error_message: - Description: Provides the reason for the error - Value: Sample value: Customer not found - Tags: String #### status: - Description: Error status - Value: Sample value:ERROR - Tags: String #### error_code: - Description: Specifies the Error code - Value: Sample value:INVALID_REQUEST - Tags: String #### error_info: - Description: Additional information on the error message - Value: - **User_message**: - Description: Error message can be displayed to the user - Value: Sample value:Cannot process your request as customer not found. - Tags: String - **Developer_message**: - Description: Detailed info on the error - Value: Sample value:Customer not found. - Tags: String - **Category**: - Description: category of the error - Value: Sample value:USER_ERROR - Tags: String - Tags: JSON --- ## See Also - [Mandate Registration API](https://juspay.io/eu/docs/ec-api-eu/docs/mandates/mandate-registration-api) - [Mandate Execution API](https://juspay.io/eu/docs/ec-api-eu/docs/mandates/mandate-execution-api)