get https://sandbox.juspay.in/customers//mandates
A merchant can call this API to get the list of all the mandates that a customer has with them. The list will also include all revoked, expired, and failed mandates.
Response Parameters for the List Mandate API: (click to view)
| Parameter | Type | Description |
|---|---|---|
| objectwwwtww | String | "list" |
| list: [{...},{...},..] | Array | An array of Mandate Objects (see table below) |
| total | Int | Total mandates set against customer_id |
| offset | Int | Offset from start (default is 0) |
| count | Int | Count of mandate objects to be included in response Default is same as 'total' |
Mandate Objects: The elements returned in the list array are Mandate Objects, each of which includes a Payment Info Object. This provides details of all mandates a customer has (or had) with a merchant.
(click to view)
(click to view)
| Field | Type | Description |
|---|---|---|
| status | String | Status of the mandate. See Appendix for status mapping. |
| payment_info:wwwwwi {param1, param2,...} | Object nStringn | This contains the payment instrument details entered when the mandate was created (Parameters listed in table below - click to open) |
Payment Info Object Parameters:
| Field | Type | Description |
|---|---|---|
| payment_method_type | String | Payment method type used when creating the mandate. Must be either CARD, NB, WALLET, or UPI. |
| payment_method | String | Payment method used when creating the mandate. Found in the given tables for the corresponding Payment API and transaction type. |
| auth-type | String | Type of authentication used. This parameter is returned only with the "Card" response". |
| upi_details:wwwwwwi {payer_vpa} | Object String | UPI details related to customer. Payer VPA used during setting up mandate. wwt |
UPI Details Object Parameter:
| Field | Type | Description |
|---|---|---|
| payer_vpa | String | Payer VPA used during setting up mandate. |
The following objects are returned only with the "Card" response:
| card:wwwwwwwwwwww {param1, param2,...} | Object String | Card details. This parameter is included as shown in the "Card" response". |
Card Object Parameters:
| Field | Type | Description |
|---|---|---|
| using_saved_card | Boolean | True if using a saved card |
| saved_to_locker | Boolean | True if card has been saved to locker |
| last_four_digits | String | Last four digits of card number |
| name_on_card | String | Card holder name. Should contain alphabetical characters only. |
| expiry_year | String | Expiry year of the card (Format: "yyyy") |
| expiry_month | String | Expiry month of the card (Format: "mm") |
| card_type | String | "CREDIT" or "DEBIT" |
| card_issuer | String | Code for bank that issued the card (Example: "HDFC Bank") |
| card_isin | String | International Securities Identification Number for card (Example: "545721") |
| card_brand | String | Brand of card ("MASTERCARD", "VISA", etc.) |
| bank_details:wwwwwwww {param1, param2,...} | Object String | Bank details. This parameter should be included as shown in the "Card" response". |
Bank Details Object Parameters:
| Field | Type | Description |
|---|---|---|
| object | String | "bank_account" |
| id | String | Bank account ID generated by Juspay |
| customer_id | String | Customer ID sent in request. (Customer ID is provided by juspay or is the object reference ID given by merchant during customer creation.) |
| date_created | String | Date that account was created |
| bank_name | String | **Name of bank |
| account_number | String | Bank account number |
| beneficiary_name | String | Name of the customer in a given bank account |
| ifsc | String | IFSC code for a bank branch |
| validation_amount | String | Amount that account is validated for |
| currency | String | Type of currency |
| validation_status | String | Status of account (CREATED, PENDING, or ACTIVE) |
| last_validated | String | Time/date of most recent validation |
| metadata: {param1, param2, ....} | String | Custom key-value sets sent in previous request |
NOTE:
Only those parameters in bold were shown in the response for this API.
| mandate_statuswwwt | nStringn | Current status of the mandate. Must be one of the states listed in this table (ENUM format): (CREATED / ACTIVE / PAUSED / REVOKED / FAILURE / PENDING / EXPIRED) |
| mandate_id | String | Mandate ID is a unique identifier generated and sent by Juspay after mandate creation. Must be sent with Notification and Revoke Mandate APIs. For the Mandate Execution API, either mandate_id or mandate_token can be used. |
| mandate_token | String | Mandate token is a unique identifier generated and sent by Juspay for one-time use. This is a 32 digit alphanumeric unique value. Can can be sent with the Mandate Execution API along with customer_id for recurring mandate execution. Allows a charge without a 2nd factor. |
| max_amountwwwwwi | String | Maximum amount of mandate while setting a mandate. Mandatory only if mandate.amount_rule = VARIABLE. | ||||||
| currency | String | ISO string of the currency. Default value: INR (Indian Rupee). Among other accepted values are EUR, USD, GBP. | ||||||
| activated_at | String | Time stamp of mandate activation | ||||||
| start_date | String | Mandate start date in UNIX EPOCH timestamp (UTC timezone) format. In case of UPI mandate, the start date has to be today’s date. Mandatory only for UPI Mandate | ||||||
| end_date | String | Mandate end date in UNIX EPOCH timestamp (UTC timezone) format, when a mandate will move to EXPIRED state, and recurring mandate execution will not be allowed. Mandatory only for UPI Mandate. | ||||||
| amount_rule | String | Data type ENUM Possible values: FIXED, VARIABLE. By Default, it is considered as VARIABLE. In case of FIXED, max amount will be equal to amount | ||||||
| mandate_type-- | String | EMANDATE in case of UPI/NB/Wallet payment MANDATE in case of Card payment | ||||||
| block_funds | Boolean | Set to TRUE if funds have to be blocked while a mandate is being created. Should be TRUE for ONETIME and FALSE for Recurring. By default, value will be TRUE for ONETIME and FALSE for Recurring. | ||||||
| frequency | String | Defines the frequency of mandate execution, or how often a customer should be charged.Description for mandate.frequencyPossible values (ENUM format):ONETIME, DAILY, WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, YEARLY, ASPRESENTEDDefault: ASPRESENTEDCheck here for additional rules on this value. | ||||||
| rule_type | String | ON / BEFORE / AFTER For Razorpay, rule_type will be updated to BEFORE. For Paytm, rule_type will be updated to AFTER | ||||||
| rule_value | Integer | Determines the day of week or month that a mandate will be executed, depending on the mandate.frequency.Description for rule.valuePossible values (Integer format):
Not required when frequency is ONETIME, DAILY, or ASPRESENTED. For Razorpay, rule_value will be considered as the last date of the week/month/year. For Paytm, rule_value will be considered as today’s date/day.Check here for additional rules on this value. |
| revokable_by_customer | Boolean | If FALSE, the mandate cannot be revoked by the customer once set. Applicable only for UPI mandates. It should be TRUE for Recurring and TRUE/FALSE for ONETIME. By default, value will be TRUE |
| mandate_debit_token | String | Mandate token is a unique identifier generated and sent by Juspay for one-time use. This is a 32 digit alphanumeric unique value. Can can be sent with the Mandate Execution API along with customer_id for recurring mandate execution. Allows a charge without a 2nd factor.This should be changed to mandate_token, since that's how it's shown in other mandate APIs. |