ACH Debit Collections
ach_debit_collection objects represent a group of successful ach_debit objects. Each ACH debit collection contains the total funds collected from one or many ach_debit objects in a day. This endpoint allows you to reconcile your successful transactions with the lump sum credited to your bank account. ACH debit collections are created automatically after an ACH debit has been successfully collected. The API allows you to retrieve your ACH debit collections. You can retrieve individual ACH debit collections as well as a list of all of your ACH debit collections.
The ACH Debit Collections API can only be used on NACH Profiles for which you are receiving direct credit from your sponsor bank. If LotusPay is the initial creditor of your funds before paying out to you, you should use the Settlements API instead.
The ACH debit collection object
ATTRIBUTES
|
Attribute
|
Description
|
|---|---|
id string
| Unique identifier for the object.
|
object string, value is "ach_debit_collection"
| 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.
|
amount integer
| Amount to be transferred to your creditor bank account. A positive integer in paisa (one hundredth of a Rupee). e.g. 100 means Rs 1. This is the sum of amount values in all the ach_debit objects linked to this ach_debit_collection.
|
count integer
| Count of the number of ACH debits contained in this ACH debit collection.
|
date_charge date
| Charge date of the ACH Debits contained in this ACH debit collection.
|
date_value date
| Value date the payout i.e. the date the payout is expected to arrive in your bank account. This factors in delays like weekends or bank holidays.
|
bank_account string
| The identifier of the creditor_bank_account the ACH debit collection was sent to.
|
nach_profile string
| The identifier of the nach_profile the ACH debit collection was created on.
|
utr
| Unique Transaction Reference Number for the ACH Debit collection
|