API documentation | API docs for agents | OpenAPI 3.1

lifecycle

ark.record_carrier_nacha_lifecycle

Record Carrier NACHA Lifecycle through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: billing:write
ARK permissions: canViewBillingcanMakeAdjustments
Team visibility: Not entity-scoped
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: Stable key for safe replay of this exact operation input.; min length: 8; max length: 200

Request body

eventTypestringrequired

one of: submitted, not_submitted, date_changed

effectiveDatestring

Required for date_changed. Persists a new immutable default version using the original payments and bank snapshots.

providerReferencestringrequired

min length: 1; max length: 500

occurredAtstringrequired

format: date-time

reasonstringrequired

min length: 1; max length: 1000

nonTransmissionConfirmedboolean

Must be true for not_submitted or date_changed. The original file must not be processed by the bank.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/carrier-ach-files/<nachaFileId>/lifecycle' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "eventType": "submitted",
  "providerReference": "<providerReference>",
  "occurredAt": "2026-07-16T14:00:00Z",
  "reason": "<reason>"
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.okbooleanrequired

data.resultobjectrequired

Durable NACHA lifecycle command or ingress replay result.

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