Baixar a especificação OpenAPI
spherepay.yaml — OpenAPI 3.0, ~470 KB. O arquivo é servido diretamente do site de documentação e reflete a superfície mais recente da API publicada.O que está na especificação
- Todos os endpoints públicos sob
/v2/— clientes, transferências, contas bancárias, carteiras, contas virtuais (Onramper Accounts), offloader wallets, representantes empresariais, documentos, due diligence aprimorada. - Esquemas completos de requisição e resposta para cada endpoint, incluindo unions discriminadas para formatos de conta bancária específicos por moeda (USD vs. EUR vs. BRL).
- Envelopes de erro padrão e mapeamentos de código de status.
- Exemplos para os corpos de requisição mais comuns.
Usos comuns
Gerar um cliente de API
Alimente o YAML no openapi-generator ou no Speakeasy para produzir um SDK tipado em TypeScript, Python, Go, Java, Ruby e outros.
Importar no Postman ou Insomnia
Postman → Import → solte o arquivo. Você obterá uma coleção pré-configurada com todos os endpoints, pronta para autenticar com sua chave de API.
Validar requisições no CI
Use o Spectral ou qualquer linter compatível com OpenAPI para validar os payloads de requisição da sua aplicação antes de chegarem à produção.
Simular a API localmente
Ferramentas como o Prism criam um servidor mock local a partir da especificação, para que você possa desenvolver contra o contrato do SpherePay sem consumir tráfego de sandbox.
Versionamento
A especificação acompanha a API/v2/ em produção. Mudanças incompatíveis são anunciadas nas Notas de versão antes de a especificação ser alterada; campos depreciados são mantidos na especificação com deprecated: true até a remoção.
Se você precisar fixar uma versão histórica específica da especificação, verifique o histórico do Git neste arquivo no repositório de documentação.