API reference

Frame is a REST API. Every resource — accounts, charge intents, customers, payouts, invoices — has its own page under Endpoints, generated directly from the OpenAPI specification so the request and response shapes always match what the live API accepts. The Integrations pages cover the cross-cutting behaviour that applies across resources, plus the SDKs you can use instead of calling the API by hand.

What's here

  • Endpoints — one page per resource, generated from openapi.yaml. Each page lists the operations on that resource with their parameters, request bodies, and response schemas.
  • Integrations — authentication, webhooks, pagination, rate limits, currencies, testing, and the SDK installs.

Conventions

A few things hold across the entire surface, so the individual resource pages don't repeat them:

  • Base URL — all endpoints live under https://api.framepayments.com, and every path is versioned with a /v1 prefix (for example, POST https://api.framepayments.com/v1/accounts). A staging host is available at https://api.staging.framepayments.com.
  • Authentication — pass your secret API key as a bearer token: Authorization: Bearer sk_production_... (or sk_sandbox_... in sandbox). Client-side flows use a publishable key (pk_production_... / pk_sandbox_...) instead. See authentication.
  • JSON — requests and responses are JSON. Timestamps are ISO 8601 strings (for example, 2026-01-15T09:30:00Z).
  • Amounts — monetary amounts are integers in the currency's minor unit (cents for USD), and currency codes are lowercase ISO 4217 (usd). See currencies.
  • Lists — list endpoints are paginated and return a consistent pagination envelope. See pagination.
  • Rate limits — the API is rate limited per key; see rate limits.

SDKs

You can call the API directly over HTTP, or use a Frame SDK:

  • Backend SDKs — official server-side libraries handle authentication, request signing, and typed resources so you don't have to construct requests by hand. See backend SDKs for installation.
  • Web SDKs — browser libraries for client-side flows (collecting card details, hosted onboarding). See the Frame.js integration.
  • Mobile SDKs — iOS and Android SDKs are on the roadmap and not yet generally available.

Testing

Use a sandbox secret key (sk_test_...) against the API to exercise the full surface without moving real money. See testing.