Create an ACH debit
Creates a new ACH debit object.
This fails with a invalid_mandate_usage error if the specified mandate's status is not active i.e. acknowledged, cancelled, failed or expired.
ACH debits can be created against mandates with status of active. ACH debits can be created on both internal mandates (those that were created in LotusPay) and external mandates (those that were created elsewhere and imported into LotusPay). For external mandates, you should ensure that the mandate is in an active status in NPCI NACH MMS else the ACH debit will fail (LotusPay does not validate ACH debits on external mandates).
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 REQUIRED
| Amount in paisa (one hundredths of a Rupee). Must be less than or equal to the mandate's amount_maximum or equal to the mandate's amount_collection.
|
creditor_agent_code optional, default is mandate's creditor_agent_code
| This argument is being deprecated in June 2022, replaced with the nach_profile argument. Four-character NACH bank code of the creditor's bank (known as the sponsor bank) e.g. HDFC. Enables you to choose which sponsor bank to process the ACH debit transaction with. That sponsor bank must be holding the mandate data (either as the original sponsor bank for the mandate's registration, or as an additional sponsor bank via corporate portability).
|
date_charge optional, default is the earliest date possible
| The date (today or a future date) on which the ACH debit should be collected. If not specified, the ACH debit will be collected as soon as possible. Must be on or after the mandate’s date_first_collection and on or before the mandate's date_final_collection. date_charge will be rolled forward by LotusPay to the next working day if it is not a working day. If created before the cutoff time on a working day and passed with no date_charge or date_charge today, the ACH debit will be collected on the same day, else it will be rolled forward by LotusPay.
|
nach_profile optional, default is the mandate's nach_profile
| The NACH profile on which to create the ACH debit. The nach_profile must be active. The nach_profile's utility code must match the mandate's utility code. The nach_profile must contain a creditor_bank_account.
|
product_type optional, default is 10
| The NACH product type of the transaction. Either 10 (for first presentation) or RPN (for representation of a previously returned transaction).
|
reference2 optional
| Resellers identifier for the sub-merchants
|
reference3 optional
| Resellers identifier for the sub-merchants
|
reference4 optional
| Merchants can pass Additional Information.
|
reference5 optional
| Merchants can pass Additional Information.
|
reference_creditor optional
| The merchant's input reference for the transaction. Max 20 characters, alpha-numeric. A human-readable description of the transaction. This will be included in the notification email LotusPay sends to your customer.
|
mandate conditional REQUIRED
| The identifier of the mandate against which this ACH debit should be collected. Either mandate or umrn must be supplied (one or the other, not both).
|
umrn conditional REQUIRED
| The NACH Unique Mandate Reference Number of the mandate against which this ACH debit should be collected. Either mandate or umrn must be supplied (one or the other, not both).
|
nach_profile_split optional
| This Nach Profile Split is used to split the amount between two different nach profile id's ( Eg: "nach_profile_split":{"NP0037EREJ1LSS" : 9800, "NP00846QEJV219" : 200} )
|
Returns Returns a newly created ACH debit object.
Request
Response
API Endpoints
Sandbox Link
POST
https://api-test.lotuspay.com/v1/ach_debits
Production Link
POST
https://api.lotuspay.com/v1/ach_debits
200 : Success