API documentation | API docs for agents | OpenAPI 3.1

{nachaFileId}

ark.update_carrier_ach_file_status

Updates the status of a visible carrier ACH/NACHA batch after bank upload, processing, or rejection.

Availability: Expanded preview
Scopes: loads:readbilling:write
ARK permissions: canViewLoadscanViewBillingcanMakeAdjustments
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

nachaFileIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

statusstringrequired

one of: GENERATED, UPLOADED, PROCESSED, REJECTED

Example request

Shell

curl -X PATCH 'https://arktms.com/api/v1/billing/carrier-ach-files/<nachaFileId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "GENERATED"
}'

Success response

Updated carrier ACH file status

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.nachaFileIdstringrequired

format: uuid

data.batchNumberintegerrequired

data.previousStatusstringrequired

data.statusstringrequired

one of: GENERATED, UPLOADED, PROCESSED, REJECTED

data.messagestringrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry
HTTP 422: Invalid request