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 also include all revoked, expired, and failed mandates.

  Response Parameters for the List Mandate API:         (click to view)
ParameterTypeDescription
objectwwwtwwString"list"
list: [{...},{...},..]ArrayAn array of Mandate Objects     (see table below)
totalIntTotal mandates set against customer_id
offsetIntOffset from start (default is 0)
countIntCount 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)
FieldTypeDescription
payment_info:wwwwi
   {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:
FieldTypeDescription
payment_method_typeStringPayment method type used when creating the mandate. Must be either CARD, NB, WALLET, or UPI.
payment_methodStringPayment method used when creating the mandate. Found in the given tables for the corresponding Payment API and transaction type.
auth-typeStringType of authentication used. This parameter should be included as shown in 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:
FieldTypeDescription
payer_vpaStringPayer VPA used during setting up mandate.
card:wwwwwwwwwwww
    {param1, param2,...}
Object
String
Card details. This parameter should be included as shown in the "Card" response".
    Card Object Parameters:
FieldTypeDescription
using_saved_cardBooleanTrue if using a saved card
saved_to_lockerBooleanTrue if card has been saved to locker
last_four_digitsStringLast four digits of card number
name_on_cardStringCard holder name. Should contain alphabetical characters only.
expiry_yearStringExpiry year of the card (Format: "yyyy")
expiry_monthStringExpiry month of the card (Format: "mm")
card_typeString"CREDIT" or "DEBIT"
card_issuerStringCode for bank that issued the card
(Example: "HDFC Bank")
card_isinStringInternational Securities Identification Number for card    (Example: "545721")
card_brandStringBrand 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:
FieldTypeDescription
objectString"bank_account"
idStringBank account ID generated by Juspay
customer_idStringCustomer ID sent in request. (Customer ID is provided by juspay or is the object reference ID given by merchant during customer creation.)
date_createdStringDate that account was created
bank_nameString**Name of bank
account_numberStringBank account number
beneficiary_nameStringName of the customer in a given bank account
ifscStringIFSC code for a bank branch
validation_amountStringAmount that account is validated for
currencyStringType of currency
validation_statusStringStatus of account (CREATED, PENDING, or ACTIVE)
last_validatedStringTime/date of most recent validation
metadata:
   {param1, param2, ....}
StringCustom key-value sets sent in previous request
NOTE:
Only those parameters in bold were shown in the response for this API.
mandate_statuswwwtnStringnCurrent status of the mandate. Must be one of the states listed in this table (ENUM format):
(CREATED / ACTIVE / PAUSED / REVOKED / FAILURE / PENDING / EXPIRED)
mandate_idStringMandate 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_tokenStringMandate 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_amountwwwwwiStringMaximum amount of mandate while setting a mandate. Mandatory only if mandate.amount_rule = VARIABLE.
currencyStringISO string of the currency. Default value: INR (Indian Rupee). Among other accepted values are EUR, USD, GBP.
activated_atStringTime stamp of mandate activation
start_dateStringMandate 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_dateStringMandate 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_ruleStringData 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--StringEMANDATE in case of UPI/NB/Wallet payment
MANDATE in case of Card payment
block_fundsBooleanSet 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.
frequencyStringDefines the frequency of mandate execution, or how often a customer should be charged.
(see description for mandate.frequency here.)
Default: ASPRESENTED
rule_typeStringON / BEFORE / AFTER
For Razorpay, rule_type will be updated to BEFORE.
For Paytm, rule_type will be updated to AFTER
rule_valueIntegerDetermines the day of week or month that a mandate will be executed, depending on mandate.frequency.
(see description for mandate.rule_value here.)
revokable_by_customerBooleanIf 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
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!