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.

Response parameters:

ParameterTypeDescription
objectString“list”
listArrayAn array of Mandate Object
totalIntTotal mandates set against customer_id
offsetInt0
countIntTotal mandates set against a customer_id

Mandate Object:

FieldTypeDescription
statusStringMandate status ENUM. CREATED | ACTIVE | PAUSED | REVOKED | FAILURE | EXPIRED
See Appendix for status mapping.
mandate_idStringMandate id sent by Juspay after mandate creation.
mandate_debit_tokenStringOne time token for recurring mandate execution.
mandate_tokenStringMandate token sent by Juspay after mandate creation.
max_amountNumberMax amount of mandate set while creating a mandate
currencyStringCurrency set while creating a mandate
payment_infoPaymentInfo ObjectIt contains the payment instrument details using which the mandate was created
activated_atStringTime stamp of mandate activation
start_dateStringMandate start date in UNIX EPOCH timestamp (UTC timezone) format.
end_dateStringMandate end date in UNIX EPOCH timestamp (UTC timezone) format.
amount_ruleStringAmount rule : VARIABLE or FIXED
mandate_typeStringMandate type: MANDATE(Cards) or EMANDATE (Rest all)
revokable_by_customerBooleanRevokable by customer : true or false
block_fundBooleanBlock fund is true or false
frequencyStringFrequency of mandate set. By default ASPRESENTED
rule_typeStringRule type ON | BEFORE | AFTER
rule_valueStringRule value
bank_detailsObjectThis block will be available for only NB / CARD and mandate_type = EMANDATE mandate flows
descriptionStringShort description for the order such as product name, plan name.

PaymentInfo Object:

FieldTypeDescription
payment_method_typeStringPayment method type used at the time of creating a mandate
payment_methodStringPayment method used at the time of creating a mandate
upi_detailsObjectUPI details related customer

UPI

FieldTypeDescription
payer_vpaStringPayer VPA used during setting up mandate

bank_details block

FiledTypeDescription
beneficiary_nameStringAccount holder name.
account_numberStringBank account number
bank_nameStringBank name
ifscStringIFSC Code of the bank.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!