API reference
API reference
All payment and management endpoints. Base path /api/v1. Send BOSPay-Version with every request.
Authenticate with X-API-Key (or Authorization: Bearer) using a secret or restricted key. Checkout session routes use the session token instead. Every response carries X-Request-Id and BOSPay-Version.
Resources
| Resource | Create | Read |
|---|---|---|
| Invoices | POST /invoices | GET /invoices/:id |
| Checkout sessions | POST /checkout-sessions | Session token on the embed |
| Destinations | PUT /settlement-addresses | GET /settlement-addresses |
| Webhooks | POST /webhooks | GET /webhooks, GET /webhooks/:id/deliveries |
| Events | — | GET /events, GET /events/:id |
| Realtime tokens | POST /realtime/tokens | — |
| Networks | — | GET /networks |
| Currencies | — | GET /currencies |