Base URL
/v1. There is one production base URL — use this in all your API calls.
Versioning
| Version | Path | Notes |
|---|---|---|
| Current | /v1 | Additive changes (new fields, routes) may ship without a major bump. |
| Future | /v2 | Breaking changes migrate with notice and dual-run where possible. |
Transport
| Topic | Convention |
|---|---|
| TLS | HTTPS only in production. |
| Encoding | UTF-8 JSON unless a route returns binary (invoices). |
| Auth | Authentication — Authorization: Bearer. |
How to read this reference
- Guides explain concepts (Learn and Concepts).
- API reference pages document HTTP methods, paths, and representative payloads with inline field documentation.
- Field types, enums, and validation rules are documented inline on each endpoint page.
Quick links
Authentication
Bearer tokens, scoping, and errors.
Conventions
Rate limits, idempotency, pagination, errors.
Messages
Core send, revoke, and status routes.
Errors
HTTP status catalog and client handling.