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:

Parameter

Type

Description

object

String

“list”

list

Array

An array of Mandate Object

total

Int

Total mandates set against customer_id

offset

Int

0

count

Int

Total mandates set against a customer_id

Mandate Object:

Field

Type

Description

status

String

Mandate status ENUM. CREATED | ACTIVE | PAUSED | REVOKED | FAILURE | PENDING | EXPIRED
See Appendix for status mapping.

mandate_id

String

The id of the mandate

mandate_debit_token

String

One time token for recurring mandate execution

max_amount

Number

Max amount of mandate set while creating a mandate

currency

String

Currency set while creating a mandate

payment_info

PaymentInfo Object

It contains the payment instrument details using which the mandate was created

activated_at

String

Time stamp of mandate activation

start_date

String

Mandate start date in UNIX EPOCH timestamp (UTC timezone) format.

end_date

String

Mandate end date in UNIX EPOCH timestamp (UTC timezone) format.

amount_rule

String

Amount rule : VARIABLE or FIXED

mandate_type

String

Mandate type: MANDATE(Cards) or EMANDATE (Rest all)

revokable_by_customer

Boolean

Revocable by customer : true or false

Block_fund

Boolean

Block fund is true or false

frequency

String

Frequency of mandate set. By default ASPRESENTED

rule_type

String

Rule type ON | BEFORE | AFTER

rule_value

String

Rule value

bank_details

Object

This block will be available for only NB / CARD and mandate_type = EMANDATE mandate flows

PaymentInfo Object:

Field

Type

Description

payment_method_type

String

Payment method type used at the time of creating a mandate

payment_method

String

Payment method used at the time of creating a mandate

upi_details

Object

UPI details related customer

UPI

Field

Type

Description

payer_vpa

String

Payer VPA used during setting up mandate

bank_details block

Filed

Type

Description

beneficiary_name

String

Account holder name.

account_number

String

Bank account number

bank_name

String

Bank name

ifsc

String

IFSC Code of the bank.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!