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
| Lane | External |
| Auth header | X-API-Key: <external-api-key> |
| Key source | Platform Ext API Keys UI (btk_…, scopes for remittance-export). Not the classic Authentication API self-serve flow. |
See Connect. This is not the same host or key store as Platform APIs (Disputes, Users, Payment rules) on arc-aegis….
Authentication¶
All endpoints (except the public schema) require an external API key on the external gateway:
X-API-Key: btk_…
The key is authenticated at ext-api-proxy (external auth-service). This service never sees or validates x-api-key directly—the proxy strips it and forwards tenant identity (x-bt-tenant-id). All data returned is scoped to your tenant.
There is no key-create or key-revoke endpoint on Remittance export. Issuance and revocation are managed with other external keys in the platform Ext API Keys experience (same external key system as Ingest—not platform user keys from Authentication).
Exception: GET /schema is public — it does not require an X-API-Key header when called through paths that allow unauthenticated schema access; through the external gateway, follow your environment’s published rules and Connect.
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.