API overview
Authentication, errors, pagination, idempotency. The basics every Strimz API call shares.
The Strimz API is a single host (https://api.strimz.finance) serving JSON over HTTPS. Every endpoint is documented in OpenAPI 3.1 and rendered by Scalar for an interactive "try it" experience.
Base URL
Test and live mode share the same host. The sk_test_ or sk_live_
prefix on your key decides which mode the request lands in.
Authentication
See Authentication for the full breakdown.
Errors
Every error returns a JSON envelope:
The full code list is on Errors. Always include the
requestId when reporting an issue; it's the key support uses to
find your request in the logs.
Pagination
List endpoints return:
Pass ?cursor=<nextCursor> on the next call. limit defaults to 25, max 100.
Idempotency
POST endpoints accept an Idempotency-Key header. See Idempotency.
Versioning
Strimz uses date-based API versions. The current version is 2026-04-27 (set in your Strimz-Version header on every request, or pinned in your dashboard).
Breaking changes only ship in a new dated version. Old versions remain available for at least 12 months after a successor lands.
Rate limits
The API enforces a 600 req/min global rate limit per IP at the edge. Authenticated requests get a higher per-key limit (10,000 req/min on Starter, custom on Enterprise). Exceeding either returns 429 with a Retry-After header.
Resources
Every resource has its own page in the sidebar. The most-used ones:
- Payment sessions. One-shot checkouts.
- Subscriptions. Recurring revenue.
- Refunds. Server-intent plus wallet-signed transfers.
- Webhooks. Register endpoints, replay deliveries.
- Invoices. Hosted, branded payment pages.
Try it
A one-line sanity check against the test API:
