Pular para o conteúdo principal

Visão Geral da Arquitetura

Legenda de evidências: [FATO] = observado em finway.json, nos guias migrados ou na API Reference (/api). [INFERÊNCIA] = deduzido dessas fontes, a confirmar. [TODO] = não observável nas fontes atuais; precisa ser fornecido pelos times.

O que é o FinWAY

O FinWAY é uma plataforma de serviços bancários exposta como API unificada (Finway API v2.0.0) [FATO — finway.json info.title/version]. A API concentra operações de contas, onboarding, Pix, transações, segurança/autenticação, webhooks e tratamento de infrações (MED) [FATO — info.description e tags do OpenAPI].

  • Base path da API: /api/bank-services [FATO — servers]
  • Ambiente publicado no spec: https://api-finway-dev.finaya.tech/api/bank-services (apenas dev/sandbox) [FATO — servers]. Ambientes de homologação/produção: [TODO].

Diagrama de Contexto

Diagrama de contexto de alto nível, inferido dos atores e integrações citados nos guias e no OpenAPI. [INFERÊNCIA] — as fronteiras internas dos serviços não foram modeladas (Fase 4B).

[INFERÊNCIA] Os nós BACEN e provedores de OTP derivam dos domínios Pix/MED e dos fluxos de OTP descritos nos guias; a topologia exata de integração é [TODO].

Principais Capacidades

Capacidades inferidas das tags do OpenAPI e dos guias [FATO]:

CapacidadeTags OpenAPI relacionadasEvidência
Segurança / AutenticaçãoAuthentication, OAuth Token, Credentials Management, Devices Management, Change Password, Change Pin, Password Recovery[FATO]
Onboarding PF/PJOnboarding PF, Onboarding PJ[FATO]
AccountsAccounts, Notifications, Storage Files[FATO]
PixPix Keys, Pix Transfer, Pix Limits, Pix Automatic, Pix Claims[FATO]
Pix Charge / QR Code DinâmicoDynamic QR Code, Dynamic QR Code Webhooks[FATO]
TransactionsTransactions[FATO]
WebhooksWebhooks, Dynamic QR Code Webhooks[FATO]
MED (infração/devolução)MED[FATO]
Crédito(nenhuma tag no finway.json atual)[INFERÊNCIA] — coberto pelo guia Crédito; endpoints não presentes nesta OpenAPI. Ver "O que precisa ser validado".

Ver a referência completa por domínio em API Reference e o detalhamento de domínios em Bounded Contexts.

Componentes Externos Conhecidos

  • Clientes / parceiros integradores — autenticam com client_id + token [FATO].
  • API FinWAYFinway API v2.0.0, base /api/bank-services [FATO].
  • Provedores / serviços financeiros — ecossistema Pix/BACEN, provedores de OTP (SMS/e-mail) [INFERÊNCIA].
  • Ambiente sandbox/devapi-finway-dev.finaya.tech [FATO].

O que ainda precisa ser validado

  • [TODO] Ambientes de homologação e produção (URLs/base paths).
  • [TODO] Arquitetura interna dos microsserviços (o monorepo possui múltiplos repositórios; o mapeamento serviço→domínio não é observável só pela OpenAPI) — Fase 4B.
  • [TODO] Qual API serve o domínio de Crédito (ausente das tags do finway.json).
  • [TODO] Integrações externas concretas (BACEN/DICT/SPI, provedores de OTP, HSM se houver).
  • [TODO] Diagramas C4 de contêiner/componente.