ACH batches
How to retrieve or settle ACH batches
Every successful ACH transaction is included in an ACH batch. The ACH transaction response will contain batchId
, statusBatch
and dateClosed
values.
- The
batchId
value is the uniqueid
for the ACH batch the transaction is included in. - The
statusBatch
value indicates whether the batch is open or closed.- 1 = open
- 2 = closed
- The
dateClosed
value indicates when your ACH batch was closed. The ACH batch closure process is automatic and begins daily at 5PM in your local time zone.
You can use the Collects all ACH batches endpoint to retrieve additional information about your ACH batches, including transaction amounts and quantities. This endpoint will return a JSON object with an array of batches.
// Example response from the Collects all ACH batches endpoint
{
"batches": [
{
"batchId": 47339,
"merchantId": 208967,
"statusBatch": 2,
"amountWithdrawals": 5,
"countWithdrawals": 1,
"amountDeposits": 0,
"countDeposits": 0,
"amountReversed": 5,
"countReversed": 1,
"amountRefunded": 0,
"countRefunded": 0,
"dateOpened": "2023-11-21 10:09:58",
"dateClosed": "2024-04-16 16:15:37"
}
]
}
You can use the Settle an ACH batch endpoint to settle an ACH batch before it's automatic closure time, by passing the respective batchId
and an idempotency-key
.
Updated 1 day ago