Primeiros passos

Fluxo de integração

Percurso de sucesso de uma integração iframe. O callback é enviado antes de o frontend ser notificado.

sequenceDiagram
participant U as Usuário
participant W as Seu site
participant WG as Wealth Reader Widget
participant API as Wealth Reader API
participant B as Instituição financeira
U->>W: Abra o app
W->>WG: Insira o iframe com operation_id
U->>WG: Escolha a entidade e dê consentimento
WG->>API: Solicite os dados com operation_id
API->>B: Peça os dados da conta
B-->>API: Retorna dados brutos
API-->>WG: Retorna dados normalizados
WG->>W: Envie um POST para o callback (operation_id + token + payload)
W-->>WG: Responda HTTP 200 e status ok
WG-->>W: Envie postMessage flow completed
W-->>U: Exibe a tela de sucesso

Quem faz o quê

Ator	Responsabilidade
O seu frontend	Gera um `operation_id` único, carrega o widget e escuta `postMessage`.
O widget	Mostra bancos, início de sessão, 2FA e erros ao utilizador.
A API do Wealth Reader	Comunica com a instituição e normaliza a resposta.
O seu backend	Expõe o URL de callback, responde `{"status":"ok"}` e guarda `operation_id`, `token` e payload.

Se algo falhar

Palavra-passe errada, 2FA ou erro da instituição: o widget trata disso com o utilizador. O seu frontend pode receber um JSON de erro via postMessage; o callback não é chamado até a leitura terminar com sucesso.
O seu callback não devolve 200 + {"status":"ok"}: o utilizador não vê o sucesso e o frontend não recebe flow completed.
Um token deixa de funcionar (alteração de palavra-passe, novo 2FA): volte a abrir o widget passando esse token para o utilizador se voltar a autenticar.

O detalhe das mensagens e do corpo do callback está nas páginas iframe.

Passo seguinte

Se integrar via iframe, continue com frontend e depois backend. Se não puder incorporar um iframe, vá a OAuth.

Última atualização 2026-08-24