Overview¶
The Billtrust platform provides REST APIs so customers can build their own processes and access data in near real time.
Public APIs are split into two lanes:
| Lane | Base URL (prod) | Examples |
|---|---|---|
| Platform | https://arc-aegis.billtrust.com |
Users, Disputes, Credit, Payment rules |
| External | https://ext.arc-aegis.billtrust.com |
Ingest, Remittance export |
Before you call any endpoint, read Connect for base URLs, headers, and how keys are issued. Platform keys and external keys are not interchangeable.
How these docs are organized¶
- Connect — gateways and credentials
- Authentication — platform login + self-serve platform API keys
- Common headers — header reference
- Product sections — resources, payloads, and examples for each API
- API reference — interactive OpenAPI
Examples in these docs¶
Examples use curl with bash syntax. If you use another shell (for example Windows cmd or PowerShell), adjust quoting accordingly. You can use any language that can make HTTPS requests and parse JSON.