Openi DeveloperDeveloper

Início

Com uma única API, conectamos os dados financeiros dos seus usuários para que você possa criar produtos únicos para seus clientes em minutos.

Esta documentação foi criada para facilitar e acelerar seu processo de integração com a Openi - Open Finance.

Nossa API oferece endpoints completos para conectar, gerenciar e remover conexões ou itens financeiros de forma simples e eficiente.

Por onde começar

  1. Connect (Widget) — A forma mais rápida de integrar: crie uma sessão via API e envie o usuário para uma interface pronta que cuida de todo o fluxo de conexão (instituição, credenciais, OAuth), sem que sua aplicação manipule credenciais.
  2. Fluxo de conexão — Passo a passo completo para conectar uma instituição financeira via API direta (cadastro de webhook, listar conectores, criar item, OAuth, uso dos dados). Recomendado para quem quer controle total da experiência.
  3. Como receber webhooks — Fluxo exato para configurar seu endpoint e processar notificações (validação do Authorization, retentativas, idempotência).
  4. Collection Postman — Baixe a collection para testar os endpoints da API sem codar (conectores, itens, contas, transações, webhooks).

Estrutura da documentação

  • Connect (Widget) — Interface pronta e hospedada para o usuário final conectar a conta dele.
  • Conectores — Listar e buscar instituições disponíveis para conexão.
  • Itens — Criar e gerenciar conexões (itens) com instituições.
  • Conta bancária — Contas e transações (endpoints por item/conta).
  • Webhooks — Cadastro de webhooks e referência dos eventos enviados.
  • Ferramentas — Postman e outros recursos para desenvolvimento.

On this page