Remittance Export API — Reference Overview

Swagger documentation: https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Remittance%20Export%20API%201.0.0

The Remittance Export API provides programmatic, read-only access to payment and remittance data. It is designed for technical suppliers and AI agents that need to query payment records directly, without relying on file downloads or SFTP polling.

Base URL

https://ext.arc-aegis.billtrust.com/api/v1/remittance-export

Authentication

All endpoints require an X-API-Key header, same as every other service behind the proxy:

X-API-Key: <your-api-key>

The key is authenticated at the edge — this service never sees or validates it directly. Once authenticated, the proxy forwards your tenant identity internally; all data returned is scoped to your tenant automatically. There is no separate key-management endpoint in this API — key issuance and revocation are handled the same way as for every other service behind the proxy.

Exception: GET /schema is public — it does not require an X-API-Key header.

Endpoints

Section	Endpoints	Description
Schema	GET /schema	Field catalog introspection. Public — no X-API-Key required.
Payments	POST /payments/query	Cursor-paginated payment queries.
Export Runs	GET /export-runs/{scheduleId}/status, GET /export-runs/{scheduleId}/data	Poll scheduled run status and retrieve the frozen data snapshot from the most recent completed run.
Schedules	GET/POST /schedules, DELETE /schedules/{id}	Manage recurring export schedules. Minimum interval is 5 minutes.
Webhooks	GET/POST /webhooks, GET /webhooks/{id}/deliveries, DELETE /webhooks/{id}	Register callback URLs to receive export.completed/export.failed events instead of polling.
Audit Logs	GET /audit-logs	Query/search your own tenant's audit trail — one entry per API request your tenant made.

Data Sources

POST /payments/query and scheduled exports both accept a source field that selects the underlying payment data to query:

Source	Data
cashapp	Cash application payment records
iandp	Invoice and payment data
bpn	Billtrust Payment Network data

Call GET /schema first to discover which fields are available for each source before building a query — see Schema.

Pagination

All payment queries and data snapshots use cursor-based pagination. The response includes a pagination.cursor token — pass it as cursor in the next request to fetch the subsequent page. A null cursor means all results have been returned.

Default page size is 500 rows; maximum is 100,000 rows per request.

Rate Limiting

Rate limit exceeded — 1,000 requests/minute and 50,000 requests/hour by default. Check the Retry-After response header. Exceeding the limit gets you a 429 error.

Interactive Reference

The full interactive API reference is available in the Swagger UI under Remittance Export API.