Dados & APIs

Esta seção reúne a referência técnica de dados e contratos da plataforma FinWAY.

API Reference

A API Reference é renderizada pelo Scalar (@scalar/docusaurus) a partir do arquivo finway.json (OpenAPI 3.0.3). É uma referência interativa — com cliente de testes ("try it out") embutido — que cobre as operações REST da Finway API v2.0.0, navegável por domínio/tag.

Servidor de desenvolvimento

Esta referência usa atualmente o servidor de desenvolvimento definido em finway.json (https://api-finway-dev.finaya.tech/api/bank-services). Antes da publicação externa para parceiros, o OpenAPI deve incluir os servidores de homologação/produção — ou esta limitação deve ser explicitamente comunicada aos integradores.

Fonte única da verdade

• O finway.json é a fonte única da verdade dos contratos de API, servido em /finway.json (arquivo em static/finway.json).
• O Scalar lê a spec em runtime — não há páginas MDX geradas para manter nem etapa de pré-build.
• Para corrigir um contrato, altere o finway.json (no fluxo do serviço de origem); a referência reflete a mudança no próximo build.

Eventos & Webhooks

Os eventos entregues via webhook têm uma seção dedicada em Eventos & Webhooks:

• Visão Geral de Eventos — domínios, status e lacunas conhecidas.
• Referência de Webhooks — catálogo de payloads por domínio (Markdown manual).
• Roadmap AsyncAPI — proposta de evolução para contrato gerado.

O guia de jornada permanece em Webhooks. A evolução para AsyncAPI (contrato gerado) está descrita no roadmap.

Modelo de Dados

Em construção

A documentação de modelo de dados será adicionada em fase posterior, preferencialmente gerada a partir do schema de cada serviço (ver DOCS-ADR-002).