{nachaFileId}

ark.get_carrier_ach_file

Returns a visible carrier ACH/NACHA batch with entries and linked carrier payments for reconciliation.

Parameters

None.

Shell

curl 'https://arktms.com/api/v1/billing/carrier-ach-files/<nachaFileId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Carrier ACH file

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.nachaFileIdstringrequired

format: uuid

data.batchNumberintegerrequired

data.fileNamestringrequired

data.effectiveDatestringrequired

format: date

data.totalAmountstringrequired

Decimal total amount as a string.

data.entryCountintegerrequired

data.statusstringrequired

data.createdAtstringrequired

format: date-time

data.createdByNamestringrequired

data.csvDataarray<any> | object | nullrequired

Stored reconciliation CSV metadata for the batch.

data.entriesarray<object>required

data.paymentsarray<object>required