JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Mandates

mandate objects represent the NACH Debit mandates with customers. Mandates are attached to customer and bank_account objects, and can optionally have subscription objects attached to them. ach_debit objects are created on mandate objects. The API allows you to retrieve your mandates. You can retrieve individual mandates as well as a list of all of your mandates. The API also allows you to cancel mandates, import external mandates, update mandates and search for mandates.

Internal mandates are those that were created in LotusPay. External mandates are those that were created elsewhere.

To create mandates, use the source endpoint. The exact set of values from amount_collection up to and including variant, as well as metadata, are all populated directly in mandate from their corresponding fields in source.

The mandate object

ATTRIBUTES

Scroll inside to view more

Attribute	Description
id string	Unique identifier for the object.
object string, value is "mandate"	String representing the object’s type. Objects of the same type share the same value.
created timestamp	Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata hash	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
amount_collection integer	Fixed amount of the mandate. A positive integer in paisa (one hundredth of a Rupee). e.g. 10000 means Rs 100.00. Only one of amount_collection or amount_maximum will be present, never both.
amount_maximum integer	Maximum amount of the mandate. A positive integer in paisa (one hundredth of a Rupee). e.g. 10000 means Rs 100.00. Only one of amount_collection or amount_maximum will be present, never both.
category_code string	Four-character NPCI code of the mandate category e.g. U099.
category_description string	Description of the category code.
creditor_agent_code string	Four-character NACH bank code of the creditor's bank (known as the sponsor bank) e.g. HDFC.
creditor_agent_name string	Name of the sponsor bank e.g. HDFC BANK.
creditor_agent_mmbid string	11-character IFSC code of the sponsor bank e.g. HDFC0999999. This is the RTGS head office/treasury branch of the bank.
creditor_name string	Name of the creditor.
creditor_utility_code string	NACH utility code of the creditor.
date_first_collection date	First collection date (start date) of the mandate.
date_final_collection date	Final collection date (expiry date) of the mandate. Null entry means "Until Cancelled".
debtor_account_name string	Customer's name in their bank account.
debtor_account_number string	Customer's bank account number. All but last four digits are masked.
debtor_account_type string	Customer's bank account type. Value can be savings or current for all mandate variants. Value can also benre, nro, cc or other for physical mandate variant.
debtor_agent_code string	Four-character NACH bank code of the customer's bank (known as the destination bank) e.g. ICIC.
debtor_agent_name string	Name of the destination bank e.g. ICICI BANK.
debtor_agent_mmbid string	11-character IFSC code of the destination bank e.g. ICIC0000001. This is the customer's branch of the bank. Note: For emandate_api variant, the destination bank may respond with a different IFSC, but this does not affect the validity of the mandate.
debtor_email string	Customer's email address.
debtor_mobile string	Customer's mobile number.
debtor_pan string	Customer's PAN - Permanent Account Number (tax ID in India).
debtor_phone string	Customer's phone number.
frequency string	Frequency with which transaction requests can be submitted. Value can be ADHO (ad hoc, or as and when presented), MNTH (monthly), QURT (quarterly), MIAN (half-yearly) or YEAR (yearly) for all mandate variants. Value can also be INDA (intraday), DAIL (daily), WEEK (weekly) or BIMN (bi-monthly) for eMandate variants.
instrument string	Always takes the value DEBIT.
occurrence_sequence_type	The occurrence sequence type of the mandate. Value can be RCUR or OOFF. Value is RCUR if frequency value is not nil. Value is OOFF if frequency value is nil.
reference1 string	Merchant's identifier for the customer.
reference2 string	Merchant's identifier for the product or service being offered to the customer.
reference3 string	Resellers identifier for the sub-merchants.
reference4 JSON	Merchants can pass Additional Information.
reference5 JSON	Merchants can pass Additional Information.
variant string	The variant of the mandate, either physical, emandate_api or emandate_esign.
class string	Has the value internal if the mandate was originally created in LotusPay or the value external if the mandate was originally created elsewhere and then imported to LotusPay.
date_acknowledged date	For physical and emandate_esign variants, date on which the mandate was acknowledged by NPCI - the UMRN was generated. For emandate_api variant, date on which customer authorised the mandate and mandate became active.
date_responded date	For physical and emandate_esign variants, date on which the destination bank responded. For emandate_api variant, date on which customer authorised the mandate and mandate became active (same as date_acknowledged).
date_cancelled date	Date on which the mandate was cancelled.
mandate_request_id	The mandate request ID of the mandate.
reason_code string	The four-character mandate reason code. Accept code is always ac01. Reject codes beging with M and are responses from the destination bank e.g. M003. Amend code is always A001. Cancel codes range from C001 to C005.
response_description string	The description of the reason_code at the time the mandate received the code. Reason descriptions in the system can change over time.
status string	The status of the mandate, one acknowledged, active, failed, cancelled or expired.
status_cancel string	The cancel status of the mandate, one of cancel_nil, cancel_requested, cancel_submitted, cancel_confirmed, cancel_failed and cancel_received.
umrn string	The NACH unique mandate reference number of the mandate.
customer string	Identifier of the customer.
bank_account string	Identifier of the bank account.
nach_profile string	Identifier of the NACH profile.
source string	Identifier of the source.

Have questions?
Need help? Contact support
LLM? Read llms.txt