The SpherePay API is documented as an OpenAPI 3.0 specification. The spec is the source of truth for every endpoint, request schema, response schema, and error code — drop it into your favorite tool to generate clients, import collections, or feed it to your own internal services.Documentation Index
Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt
Use this file to discover all available pages before exploring further.
Download the OpenAPI spec
spherepay.yaml — OpenAPI 3.0, ~470 KB. The file is served directly from the docs site and reflects the latest published API surface.What’s in the spec
- Every public endpoint under
/v2/— customers, transfers, bank accounts, wallets, virtual accounts (Onramper Accounts), offloader wallets, business representatives, documents, enhanced-due-diligence. - Full request and response schemas for each endpoint, including discriminated unions for currency-specific bank-account shapes (USD vs. EUR vs. BRL).
- Standard error envelopes and status-code mappings.
- Examples for the most common request bodies.
Common uses
Generate an API client
Feed the YAML into openapi-generator or Speakeasy to produce a typed SDK in TypeScript, Python, Go, Java, Ruby, and others.
Import into Postman or Insomnia
Postman → Import → drop the file. You’ll get a collection seeded with every endpoint, ready to authenticate with your API key.
Validate requests in CI
Use Spectral or any OpenAPI-aware linter to validate your application’s request payloads against the spec before they hit production.
Mock the API locally
Tools like Prism spin up a local mock server from the spec, so you can develop against SpherePay’s contract without burning sandbox traffic.
Versioning
The spec tracks the live/v2/ API. Breaking changes are announced in Release notes before the spec changes; deprecated fields are kept in the spec with deprecated: true until removal.
If you need to pin against a specific historical version of the spec, check Git history on this file in the docs repository.