MCP documentation | MCP docs for agents

ark_generate_carrier_ach_file

ark.generate_carrier_ach_file

Generate an ACH/NACHA batch from READY ARK carrier payments, assign settlement numbers, record the batch, and link the payments to ACH entries.

Availability
Expanded preview
Scopes
loads:readbilling:write
ARK permissions
canViewLoadscanViewBillingcanMakeAdjustments
Team visibility
Required and enforced
Approval policy
ask_before_write
ARK approval request
Required before execution
Idempotency
Required for external execution
Read-only
No
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

carrierPaymentIdsarray<string>required

READY carrier payment IDs to include in the ACH/NACHA batch.

min items: 1; max items: 250

effectiveDatestringrequired

ACH effective date in YYYY-MM-DD format.

includeFileContentboolean

When true, return the raw NACHA file and reconciliation CSV in the initial response. These include sensitive bank payment data and are redacted from idempotent replays.

default: false

Result

The tool returns the canonical ark.generate_carrier_ach_file operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.