v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

ACH Payment

Collects all ACH batches.

get/ach/batches

Response

All ACH Batches.

batchIdinteger

The id for the ACH batch.

batchReferencestring

The reference identifier for the ACH batch.

merchantIdinteger

The id of the merchant associated with this batch.

statusBatch1 | 2

The current state of the batch. Valid values: 1 (Open), 2 (Closed).

amountWithdrawalsnumber float

The total monetary amount withdrawn.

countWithdrawalsnumber

The number of withdrawn transactions.

amountDepositsnumber float

The total monetary amount deposited.

countDepositsnumber

The number of deposited transactions.

amountReversednumber float

The total monetary amount reversed.

countReversednumber

The number of reversed transactions.

amountRefundednumber float

The total monetary amount refunded.

countRefundednumber

The number of refunded transactions.

dateOpenedstring

The timestamp indicating when the batch was opened.

dateClosedstring

The timestamp indicating when the batch was closed.

Example response

[
  {
    "batchId": 861456,
    "batchReference": "ach-1234",
    "merchantId": 8,
    "statusBatch": 1,
    "amountWithdrawals": 120.5,
    "countWithdrawals": 2,
    "amountDeposits": 150,
    "countDeposits": 2,
    "amountRefunded": 8.5,
    "countRefunded": 5,
    "dateOpened": "2026-05-06 13:01:15",
    "dateClosed": "2026-05-06 13:01:15"
  }
]