--- page_source: https://juspay.io/sea/docs/hyper-checkout-sea/web/mandates/list-mandate-api page_title: List Mandate API --- ## 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.in/customers/{customer_id}/mandates - Production: https://api.juspay.in/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 current date in YYYY-MM-DD format - Tags: String, Mandatory ## Sample Code Snippets: ### Sample Request: #### Request - UPI Code Snippet: ```request - upi curl GET 'https://api.juspay.in/customers/cst_lz7zmpemoo5okgav/mandates' \ -H 'Authorization: Basic ' \ -H 'version:2023-06-30 ``` #### Request - Card Code Snippet: ```request - card curl -X GET 'https://api.juspay.in/customers/:customer_id/mandates' \ -H 'Authorization: Basic ' \ -H 'version:2023-06-30 ``` #### Request - Netbanking Code Snippet: ```request - netbanking curl -X GET 'https://api.juspay.in/customers/testcustomer/mandates' \ -H 'Authorization: Basic '\ -H 'version:2023-06-30 ``` ### Sample Response: #### Card: ```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" } ] } ``` #### UPI: ```json { "total": 4, "offset": 0, "object": "list", "list": [ { "status": "CREATED", "start_date": "1598659200", "rule_value": 1, "rule_type": "ON", "revokable_by_customer": true, "payment_info": { "payment_method_type": "UPI", "payment_method": "COLLECT" }, "max_amount": 1000, "mandate_type": "EMANDATE", "mandate_token": "c1bd3d4948c*****ac0d6ec", "mandate_id": "uwgyQa*****bnCty4", "frequency": "MONTHLY", "end_date": "1606435200", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE" }, { "status": "FAILURE", "start_date": "1598745600", "rule_value": 1, "rule_type": "ON", "revokable_by_customer": true, "payment_info": { "payment_method_type": "UPI", "payment_method": "COLLECT" }, "max_amount": 1000, "mandate_type": "EMANDATE", "mandate_token": "78cbecbc77a04b2*****7ed712ee8", "mandate_id": "qvjcv*****Hety1siP", "frequency": "MONTHLY", "end_date": "1606521600", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE" }, { "status": "REVOKED", "start_date": "1598745600", "rule_value": 30, "rule_type": "AFTER", "revokable_by_customer": true, "payment_info": { "upi": { "payer_vpa": "99999999@paytm" }, "payment_method_type": "UPI", "payment_method": "COLLECT" }, "max_amount": 1000, "mandate_type": "EMANDATE", "mandate_token": "6ce16d59d3*****93e65f4c4221f1", "mandate_id": "7SucJZ2P*****W8Xa26", "frequency": "MONTHLY", "end_date": "1606521600", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE", "activated_at": "2020-08-30T09:08:53Z" }, { "status": "ACTIVE", "start_date": "1598745600", "rule_value": 30, "rule_type": "AFTER", "revokable_by_customer": true, "payment_info": { "upi": { "payer_vpa": "99999999@paytm" }, "payment_method_type": "UPI", "payment_method": "COLLECT" }, "max_amount": 1000, "mandate_type": "EMANDATE", "mandate_token": "ad1d28b906*****348487be790f3", "mandate_id": "3XMEcS1z2*****fVYbzj", "mandate_debit_token": "tkn_8027ce*****69456ad5590569", "frequency": "MONTHLY", "end_date": "1606521600", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE", "activated_at": "2020-08-30T09:54:10Z" } ], "count": 4 } ``` #### Net Banking: ```plaintext { "total": 2, "offset": 0, "object": "list", "list": [ { "status": "ACTIVE", "revokable_by_customer": true, "payment_info": { "payment_method_type": "NB", "payment_method": "JP_X", "bank_details": { "ifsc": "HDFC0000053", "beneficiary_name": "test", "bank_name": "JP MORGAN", "account_number": "50xxxxxxxx00" }, "auth_type": "THREE_DS" }, "max_amount": 5, "mandate_type": "EMANDATE", "mandate_token": "a0d2c3d2******2f9cb9c32", "mandate_id": "nZhm*****anHzE", "mandate_debit_token": "tkn_1d9d0b1b****801287ec938a", "frequency": "ASPRESENTED", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE", "activated_at": "2021-04-22T07:00:40Z" }, { "status": "ACTIVE", "revokable_by_customer": true, "payment_info": { "payment_method_type": "NB", "payment_method": "JP_X", "bank_details": { "ifsc": "HDFC0000053", "beneficiary_name": "test", "bank_name": "JP MORGAN", "account_number": "50xxxxxxxx00" }, "auth_type": "THREE_DS" }, "max_amount": 20, "mandate_type": "EMANDATE", "mandate_token": "72d272ba******f26b6c0d4", "mandate_id": "8M5th*****4h8D26E", "mandate_debit_token": "tkn_f62170a*****83a0663", "frequency": "ASPRESENTED", "currency": "SGD", "block_fund": false, "amount_rule": "VARIABLE", "activated_at": "2021-04-22T07:40:54Z" } ], "count": 2 } ``` ## Path Parameters: #### customer_id: Customer Id - Value: Example:- cst_lz7zmpemoo5okgav - Tags: String, Mandatory ## API Responses: ### 200: #### UPI: - 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 - **Start_date**: - Description: Mandate start date in UNIX EPOCH timestamp (UTC timezone) format. - Tags: String - **Rule_value**: - Description: Rule value - Tags: Integer - **Rule_type**: - Description: Rule type ON | BEFORE | AFTER - Tags: String - **Revokable_by_customer**: - Description: Revokable by customer : true or false - Tags: boolean - **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 - **Upi.payer_vp**: - Description: Payer VPA used during setting up mandate - 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_token**: - Description: Mandate token sent by Juspay after mandate creation. - Tags: String - **Mandate_id**: - Description: Mandate id sent by Juspay after mandate creation. - Tags: String - **Frequency**: - Description: Frequency of mandate set. By default ASPRESENTED - Tags: String - **End_date**: - Description: Mandate end date in UNIX EPOCH timestamp (UTC timezone) format. - Tags: String - **Currency**: - Description: Currency set while creating a mandate - Tags: String - **Block_fund**: - Description: Block fund is true or false - Tags: boolean - **Amount_rule**: - Description: Amount rule : VARIABLE or FIXED - Tags: String - Tags: Array of objects - **Count**: - Description: Number of Mandate records to be fetched against a customer_id - Tags: Integer - Tags: JSON #### 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 #### Net Banking: - 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 - **Revokable_by_customer**: - Description: Revokable by customer : true or false - Tags: boolean - **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 - **Bank_details**: - Value: - **Ifsc**: - Description: IFSC Code of the bank. - Tags: String - **Beneficiary_name**: - Description: Account holder name. - Tags: String - **Bank_name**: - Description: Bank name - Tags: String - **Account_number**: - Description: Bank account number - 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_token**: - Description: Mandate token sent by Juspay after mandate creation. - Tags: String - **Mandate_id**: - Description: Mandate id sent by Juspay after mandate creation. - Tags: String - **Frequency**: - Description: Frequency of mandate set. By default ASPRESENTED - Tags: String - **Mandate_debit_token**: - Tags: String - **Currency**: - Description: Currency set while creating a mandate - Tags: String - **Block_fund**: - Description: Block fund is true or false - Tags: boolean - **Amount_rule**: - Description: Amount rule : VARIABLE or FIXED - Tags: String - **Activated_at**: - Description: Time stamp of mandate activation - Tags: String - Tags: Array of objects - **Count**: - Description: Number of Mandate records to be fetched against a customer_id - Tags: Integer - Tags: JSON ### 400: #### status: - Description: ERROR - Tags: string #### error_code: - Description: INVALID_REQUEST - Tags: string #### error_message: - Description: Customer not found - Tags: string #### status_id: - Tags: integer