API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/billing/payment-destinations

ark.list_payment_destinations

Returns carrier and factoring payment destination details for billing workflows. Bank and tax credentials are always masked on the external API.

Availability: Expanded preview
Scopes: billing:read
ARK permissions: canViewBilling
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

carrier_idsquerystring: Comma-separated carrier IDs.
factoring_company_idsquerystring: Comma-separated factoring company IDs.

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/billing/payment-destinations' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

OK

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.includeSensitivePaymentFieldsbooleanrequired

data.itemsarray<object>required

data.missingobjectrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied