Base URL https://api.satlane.com. Local / self-host: http://localhost:4000.
Authed
POST
/v1/invoicesCreate an invoice (API key). Send Idempotency-Key.GET
/v1/invoicesList invoices with cursor pagination.GET
/v1/invoices/:idFetch one invoice by id.POST
/v1/invoices/:id/cancelCancel a pending invoice.POST
/v1/invoices/:id/simulateTest mode only. Fire a simulated lifecycle event.POST
/v1/stores/:id/test-invoiceOne-click test invoice from the dashboard.GET
/v1/stores/:id/webhooksList webhook endpoints for a store.POST
/v1/stores/:id/webhooksAdd a webhook endpoint.POST
/v1/stores/:id/webhooks/:wid/testSend a synthetic test webhook delivery.Public checkout
GET
/pay/invoices/:idInvoice + store branding snapshot for custom checkout.GET
/pay/invoices/:id/eventsServer-Sent Events stream of status updates.GET
/pay/invoices/:id/streamWebSocket alternative to SSE.Endpoint reference
Endpoint reference
Base URL: https://api.satlane.com (local / self-host: http://localhost:4000).
Authed (your server → ours)
| Method | Path | Notes |
|---|---|---|
POST | /v1/invoices | Create. API key. Send Idempotency-Key. |
GET | /v1/invoices | List with cursor pagination. |
GET | /v1/invoices/:id | Fetch one. |
POST | /v1/invoices/:id/cancel | Cancel pending. |
POST | /v1/invoices/:id/simulate | Test mode only; fire any event. |
POST | /v1/stores/:id/test-invoice | One-click test invoice (session). |
GET | /v1/stores/:id/webhooks | List webhook endpoints. |
POST | /v1/stores/:id/webhooks | Add endpoint. |
POST | /v1/stores/:id/webhooks/:wid/test | Synthetic test delivery. |
Public (buyer's browser → ours)
| Method | Path | Notes |
|---|---|---|
GET | /pay/invoices/:id | Invoice + store branding snapshot. |
GET | /pay/invoices/:id/events | SSE stream. |
GET | /pay/invoices/:id/stream | WebSocket alternative to SSE. |
CORS is open (Access-Control-Allow-Origin: *) on /pay/*.
Plan management, subscription invoices, and usage live in the vendor dashboard (
/billing). There is no public REST surface for choosing Trial/Basic/Pro.