Import an external mandate
RESTRICTED FEATURE - contact Support to enable
Imports an external mandate into LotusPay for further use, such as for cancelling the mandate or creating a subscription or ACH debit. You must provide accurate original mandate details sourced directly from the database of the mandate's original sponsor bank. LotusPay treats the imported mandate as active for the purpose of subsequent actions.
ARGUMENTS
Scroll inside to view more
|
Argument
|
Description
|
|---|---|
metadata optional
| 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 conditionally REQUIRED
| Collection amount of the mandate. A positive integer in paisa (one hundredth of a Rupee). e.g. 100 means Rs 1. Either amount_collection or amount_maximum must be supplied.
|
amount_maximum conditionally REQUIRED
| Maximum amount of the mandate. A positive integer in paisa (one hundredth of a Rupee). e.g. 100 means Rs 1. Either amount_collection or amount_maximum must be supplied.
|
category_code REQUIRED
| Four-character NPCI code of the mandate category e.g. U099.
|
category_description REQUIRED
| Original description of the category code.
|
creditor_agent_mmbid REQUIRED
| 11-character NACH bank code of the new sponsor bank of the mandate. Letters must be capitalised. Symbols are not permitted. An active NACH profile with this sponsor bank must be in place with the given NACH utility code.
|
creditor_agent_name REQUIRED
| Name of the new sponsor bank. Alphanumeric string in BLOCK CAPITALS; symbols are not permitted.
|
creditor_name REQUIRED
| Name of the creditor.
|
creditor_utility_code REQUIRED
| 18-character NACH utility code of the creditor of the mandate. An active NACH profile with this utility code must be in place with the given sponsor bank.
|
date_first_collection REQUIRED
| First collection date (start date) of the mandate.
|
date_final_collection conditionally REQUIRED
| Final collection date (end date) of the mandate. Must be nil if mandate continues until cancelled. Must be supplied if the original mandate contains the value.
|
debtor_account_name REQUIRED
| Name in the customer's bank account.
|
debtor_account_number REQUIRED
| Customer's bank account number. Must be at least five characters in length.
|
debtor_account_type REQUIRED
| Type of account. One of savings, current, nre, nro, cc or other.
|
debtor_agent_mmbid REQUIRED
| 11-character branch IFSC of the customer's bank account. Letters must be capitalised.
|
debtor_agent_name REQUIRED
| Name of the destination bank e.g. ICICI BANK. Alphanumeric string in BLOCK CAPITALS; symbols are not permitted.
|
debtor_email conditionally REQUIRED
| Email address of the customer. Must be supplied if the original mandate contains the value.
|
debtor_mobile conditionally REQUIRED
| Mobile number of the customer. Must be supplied if the original mandate contains the value.
|
debtor_pan conditionally REQUIRED
| PAN of the customer. Must be supplied if the original mandate contains the value.
|
debtor_phone conditionally REQUIRED
| Phone number of the customer. Must be supplied if the original mandate contains the value.
|
frequency conditionally REQUIRED
| Frequency of the mandate. Value can be ADHO, INDA,DAIL, WEEK, MNTH, BIMN, QURT, MIAN, YEAR.
|
instrument REQUIRED
| Always takes the value DEBIT.
|
occurrence_sequence_type REQUIRED
| 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 REQUIRED
| Reference 1 (customer reference) value of the mandate.
|
reference2 conditionally REQUIRED
| Reference 2 (plan/scheme reference) value of the mandate. Must be supplied if the original mandate contains the value.
|
reference3 Optional
| Resellers identifier for the sub-merchants.
|
reference4 Optional
| Merchants can pass Additional Information.
|
reference5 Optional
| Merchants can pass Additional Information.
|
mandate_request_id REQUIRED
| Mandate request ID of the mandate.
|
umrn REQUIRED
| 20-character NACH unique mandate reference number of the mandate. Must be a valid UMRN from the NPCI Mandate Management System. Must be unique across the LotusPay system.
|
date_acknowledged REQUIRED
| Date that the mandate was acknowledged.
|
date_responded REQUIRED
| Date that the mandate was responded to.
|
Returns Returns a mandate object if valid arguments were provided. The imported mandate will be in active status.
Request
Response
API Endpoints
Sandbox Link
POST
https://api-test.lotuspay.com/v1/mandates/import
Production Link
POST
https://api.lotuspay.com/v1/mandates/import