API overview

The Strimz API is a single host (https://api.strimz.finance) serving JSON over HTTPS. Every endpoint is documented in OpenAPI and rendered by Scalar for an interactive "try it" experience.

Base URL

https://api.strimz.finance

Each Strimz deployment runs in one mode. The sandbox runs on Arc testnet and accepts sk_test_ keys only; the live deployment runs on Arc mainnet and accepts sk_live_ keys only. A key of the other mode returns 403 mode_unavailable. See Authentication.

Authentication

Authorization: Bearer sk_live_xxx

See Authentication for the full breakdown.

Errors

Every error returns a JSON envelope:

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer string",
    "param": "amount",
    "details": { "issues": [...] },
    "requestId": "req-4f2"
  }
}

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:

{
  "data": [...],
  "nextCursor": "cmh3lmkw50000xv8d12345678",
  "hasMore": true
}

Pass ?cursor=<nextCursor> on the next call. limit defaults to 25, max 100.

List filters

Filters like status, kind, outcome and eventName take one value or a comma-separated list of up to 20. A list matches any of its values:

GET /v1/payment-sessions?status=confirmed,expired

An unknown value returns 400 invalid_request.

Transactions, payment sessions, subscriptions, invoices, refunds, webhook deliveries and agent activity also take from and to: ISO-8601 timestamps with a time zone, where from is included and to is not. Transactions filter on when the payment settled; the others on when the record was created.

GET /v1/invoices?from=2026-10-01T00:00:00Z&to=2026-11-01T00:00:00Z

Idempotency

Send an X-Strimz-Idempotency-Key header on a POST or PATCH and the API replays the first response for that key for 24 hours. The SDK sends one on every write. See Idempotency.

Rate limits

The API allows 600 requests per minute per IP across all routes. Some routes have a tighter limit of their own. Exceeding a limit returns 429.

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. Invoices with line items, paid through checkout.

Try it

A one-line sanity check against the test API:

curl https://api.strimz.finance/v1/merchants/me \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxx"