Pular para o conteúdo principal

Finway API - Documentação

Bem-vindo à documentação da Finway API. Aqui você encontra guias de integração step-by-step e a referência completa da API para construir soluções financeiras.

Primeiros Passos​

Para começar a integrar com a Finway, você precisará de:

  • client_id e client_secret fornecidos pela equipe Finway
  • Ambiente de desenvolvimento configurado (sandbox)
  • Conhecimento básico de APIs REST

Guias de Integração​

Onboarding​

Fluxo completo de cadastro para Pessoa Física (PF) e Pessoa Jurídica (PJ), desde o registro inicial até a criação da conta bancária.

Autenticação​

Processo de login com challenge/credential e associação de dispositivos via OTP (SMS e Email).

PIX​

Gerenciamento de chaves, transferências por chave/QR Code/conta bancária, limites, estornos e assinatura digital RSA.

Gestão de Conta​

Consulta de dados e saldo, atualização de perfil, gerenciamento de endereço, upload de documentos e preferências de notificação.

Saldo e Extrato​

Consulta de saldo atual, histórico de transações com paginação e filtros, e detalhes de transações individuais.

Crédito​

Jornada completa de crédito: consulta de produtos, simulação, contratação, gestão de faturas e antecipação FGTS.

QR Code Dinâmico​

Criação de cobranças imediatas via QR Code dinâmico, consulta, cancelamento, devolução e recebimento de webhook.

Alteração de Senha​

Fluxos de alteração de senha (usuário logado) e recuperação de senha (usuário deslogado) com validação OTP.

Alteração de PIN​

Processo seguro de alteração de PIN com dupla validação (Email + SMS).

Resposta de Infração​

Listagem e resposta a infrações PIX recebidas.

Webhooks​

Mapeamento completo de eventos e payloads para todos os domínios: PIX, Charge, Account, Transaction, Product e mais.

API Reference​

A referência completa da API está disponível na seção API Reference no menu lateral, com todos os endpoints, parâmetros, schemas e exemplos de request/response.

Autenticação​

Todas as operações requerem autenticação via token. O fluxo básico é:

  1. Gerar token com POST /api/bank-services/security/auth/tokens usando client_id e client_secret
  2. Usar o access_token retornado no header X-BuildersBank-Authorization
  3. Para operações financeiras (PIX, transferências), é necessário também assinatura digital RSA

Ambientes​

AmbienteURL Base
Sandboxhttps://api-dev.finway.com.br/api/bank-services