Pular para o conteúdo

Documentação da API Belvo (1.223.0)

Introdução

Alcance novos públicos e converta mais usuários conectando-se fácil e seguramente aos seus dados financeiros, entendendo seu comportamento e possibilitando pagamentos instantâneos com open finance. Através da nossa API, você pode acessar:

Informações Disponíveis e Métodos de Pagamento

A Belvo é uma API de open banking para a América Latina que permite que empresas acessem informações bancárias e fiscais de forma segura e ágil.

Através da nossa API, você pode acessar:

  • Informações Bancárias no Brasil
  • Informações de Emprego no Brasil
  • Informações de Emprego no México
  • Informações Fiscais no México
  • Informações Fiscais no Chile

Você também pode usar nossa API para realizar pagamentos em:

  • Brasil
  • México

Dicionários de Dados

Se você deseja a documentação de resposta em formato Excel ou CSV, por favor, baixe-a do nosso Repositório Público no GitHub: Belvo Open Finance Data Dictionaries.

Nossos arquivos EXCEL e CSV estão adicionalmente localizados em Espanhol e Português (Brasil).

Ambientes

Atualmente, oferecemos dois ambientes: sandbox e produção.

Sandbox

Disponível para:

  • 🟢 Agregação e Enriquecimento
  • ⚪️ Iniciação de Pagamento

Use nosso ambiente Sandbox para construir sua integração. Oferecemos dados fictícios que imitam casos de uso do mundo real, o que significa que você pode testar todos os endpoints, usar o widget e implementar webhooks - exatamente como faria com dados reais!

Tudo o que você precisa para começar com o ambiente Sandbox é obter suas chaves de API. Recomendamos fortemente que você comece a criar sua integração neste ambiente.

Produção

Disponível para:

  • 🟢 Agregação e Enriquecimento
  • 🟢 Iniciação de Pagamento

Depois de testar sua integração no ambiente Sandbox e estar pronto para entrar em operação, você precisará solicitar acesso ao nosso ambiente de Produção. Após solicitar o acesso, nossa equipe de Vendas entrará em contato para agendar uma reunião apenas para garantir que suas necessidades sejam atendidas, e então você precisará passar por um processo de certificação com um de nossos engenheiros para garantir que sua integração esteja funcionando de forma otimizada. Para se preparar para a reunião de certificação, basta seguir nossa lista de verificação de Integração.

Uma vez que sua integração esteja certificada, tudo o que você precisará fazer é:

  • Solicitar chaves de API de Produção (e alterar suas chaves de API do Sandbox no código para estas novas).
  • Alterar a URL base para a qual você faz solicitações de sandbox.belvo.com para api.belvo.com.
  • Se você estiver usando webhooks, certifique-se de definir uma URL de Produção para seus webhooks.

Códigos de Resposta

Usamos o seguinte código de status HTTP na resposta, dependendo do sucesso ou falha:

Código de StatusDescrição
200✅ Sucesso - O conteúdo está disponível no corpo da resposta.
201✅ Sucesso - O conteúdo foi criado com sucesso na Belvo.
204✅ Sucesso - Nenhum conteúdo para retornar.
400❌ Erro de Solicitação Inválida - A solicitação retornou um erro, detalhe no conteúdo.
401❌ Não Autorizado - As credenciais da Belvo fornecidas não são válidas.
404❌ Não Encontrado - O recurso que você tentou acessar não pode ser encontrado.
405❌ Método Não Permitido - O método HTTP que você está usando não é aceito para este recurso.
408❌ Tempo de Solicitação Esgotado - A solicitação expirou e foi encerrada pelo servidor.
428❌ Token MFA Necessário - O token MFA foi exigido pela instituição para conectar.
500❌ Erro Interno do Servidor - O detalhe do erro está disponível no corpo da resposta.

Tratamento de Erros

Os erros da API Belvo são retornados em formato JSON. Por exemplo, um erro pode ser assim:

[
    {
      "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
      "message": "Este campo é obrigatório.",
      "code": "required",
      "field": "link"
    }
]

Normalmente, uma resposta de erro terá os seguintes parâmetros:

  • request_id: um ID único para a solicitação, você deve compartilhá-lo com a equipe de suporte da Belvo para investigações.
  • message: descrição legível do erro.
  • code: um código único para o erro. Verifique a tabela abaixo para ver como lidar com cada código de erro.
  • field (opcional): O campo específico no corpo da solicitação que tem um problema.

Identificador de Solicitação

Quando você precisar de ajuda com um erro específico, inclua o identificador de solicitação (request_id) em sua mensagem para a equipe de suporte da Belvo. Isso acelerará as investigações e fará com que você volte a funcionar rapidamente.

Códigos de Erro e Solução de Problemas

Para uma lista completa de erros e como solucioná-los, consulte nosso artigo dedicado ao Tratamento de Erros.

Política de Retentativa

Erros 50x

Implemente um backoff exponencial automatizado de até cinco tentativas. Recomendamos usar um intervalo base de três segundos com um fator de dois. Por exemplo, a primeira tentativa deve ser após três segundos, a segunda tentativa após seis segundos (2 * 3), a terceira tentativa após 12 segundos (2 * 6), a quarta tentativa após 24 segundos (2 * 12) e a quinta tentativa após 48 segundos (2 * 24).

Erros 40x

Você não deve tentar novamente fazer solicitações se receber uma resposta 40x, pois isso é um erro do cliente.

A única exceção é o erro "Muitas Sessões", pois significa que seu usuário final está acessando a conta de outro navegador ao mesmo tempo. Nesse caso, implemente a mesma política de retentativa que para erros 50x.

Campos Obsoletos

Em nosso esquema, você pode ver que um campo foi marcado como deprecated. Isso significa que este campo não é mais mantido pela equipe da Belvo. Você ainda pode receber dados para este campo dependendo da instituição, no entanto, você não deve confiar neste campo.

OpenAPI: campos obrigatórios e anuláveis

Em nossa especificação de API, você verá que alguns parâmetros de resposta terão uma anotação required. De acordo com a especificação OpenAPI, quando um parâmetro de resposta é marcado como required, isso significa que a chave de resposta deve ser retornada. No entanto, o valor desse parâmetro de resposta pode ser null.

📘 Info

Em resumo, qualquer parâmetro de resposta marcado como obrigatório será retornado pela nossa API, mas o valor pode ser definido como nulo.

Baixar o arquivo de descrição OpenAPI
BelvoOpenApiSpec.json
BelvoOpenApiSpec.yaml
Visão Geral
URL
https://developers.belvo.com
Need help?
support@belvo.com
Idiomas
Servidores
Ambiente de Testes
https://sandbox.belvo.com/

Institutions

Uma instituição é uma entidade da qual a Belvo pode acessar informações. Pode ser uma:

  • instituição bancária, como o Nubank Brasil.
  • instituição fiscal, como o Servicio de Administración Tributaria (SAT) no México.
  • instituição de emprego, como o Instituto Mexicano del Seguro Social (IMSS) no México ou o Instituto Nacional do Seguro Social (INSS) no Brasil.
SchemasOperações

Widget Access Token

Operações

Consents

Um consentimento é uma permissão dada pelo usuário final para acessar seus dados financeiros na Rede de Open Finance no Brasil.

SchemasOperações

Objeto de Consentimentos (Brasil)

O esquema de consentimentos OFDA

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
display_namestring or null<= 128 characters^[\w\W]{0,128}$

O nome completo do indivíduo que iniciou o consentimento, conforme fornecido pela instituição.

Exemplo: "Jack Oswald White"
document_numberstring

O número do documento (CPF) do indivíduo.

Exemplo: "76109277673"
belvo_institution_namestring

Nome da instituição de open finance da Belvo à qual o consentimento está relacionado.

Exemplo: "ofmockbank_br_retail"
expired_atstring(date-time)

O timestamp ISO-8601 quando o consentimento irá expirar. No caso de undefined_consent_expiration ser true, este campo será null.

Exemplo: "2021-02-27T13:01:41.941Z"
undefined_consent_expirationboolean

Indique se o consentimento é por um período indefinido, ou seja, se não há expiração para o consentimento.

Exemplo: false
created_atstring(date-time)

O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.

Exemplo: "2022-02-09T08:45:50.406032Z"
statusstring or null

O status do consentimento na rede de open finance. Pode ser:

  • AUTHORISED: O consentimento ainda é válido para uso até a data de expired_at.
  • AWAITING_AUTHORISATION_CONFIRMATION: O usuário deve confirmar dentro da sua instituição.
  • AWAITING_AUTHORISATION: O usuário foi redirecionado para sua instituição para conceder consentimento.
  • REJECTED: O usuário não concedeu consentimento dentro da sua instituição.
  • EXPIRED: O consentimento expirou na data de expired_at.
  • null
Enum"AUTHORISED""AWAITING_AUTHORISATION_CONFIRMATION""AWAITING_AUTHORISATION""REJECTED""EXPIRED"null
Exemplo: "AUTHORISED"
permissionsobject

Detalhes sobre as permissões associadas ao consentimento.

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "display_name": "Jack Oswald White",
  "document_number": "76109277673",
  "belvo_institution_name": "ofmockbank_br_retail",
  "expired_at": "2021-02-27T13:01:41.941Z",
  "undefined_consent_expiration": false,
  "created_at": "2022-02-09T08:45:50.406032Z",
  "status": "AUTHORISED",
  "permissions": {
    "ACCOUNTS": [ … ],
    "CREDIT_CARDS": [ … ],
    "CREDIT_OPERATIONS": [ … ],
    "REGISTER": [ … ],
    "RESOURCES": [ … ]
  }
}

Listar consentimentos

Requisição

▶️ Uso

Com o método Consents, você pode:

  1. Listar todos os consentimentos relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).

📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

Segurança
basicAuth
Consulta
page_sizeinteger(int32)[ 1 .. 1000 ]

Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).

Padrão 100
Exemplo: page_size=100
pageinteger(int32)>= 1

Um número de página dentro do conjunto de resultados paginados.

Exemplo: page=1
omitstring

Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

fieldsstring

Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

user_documentstring[ 11 .. 14 ] charactersobrigatório

O número de CPF ou CNPJ do usuário para o qual você deseja obter informações de consentimento.

Exemplo: user_document=12345678900
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.belvo.com/api/consents/?page_size=100&page=1&omit=string&fields=string&user_document=12345678900'

Respostas

Ok

Corpoapplication/json
countinteger(int32)

O número total de resultados na sua conta Belvo.

Exemplo: 130
nextstring or null(uri)

A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).

Exemplo: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"
previousstring or null(uri)

A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

Exemplo: null
resultsArray of objects

Array de objetos de consentimento.

Resposta
application/json
{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "previous": null,
  "results": [
    { … }
  ]
}

Obter os detalhes de um consentimento

Requisição

Obtenha os detalhes de um consentimento específico.

Segurança
basicAuth
Caminho
idstring(uuid)obrigatório

O consent.id sobre o qual você deseja obter informações detalhadas.

curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.belvo.com/api/consents/{id}/'

Respostas

Ok

Corpoapplication/json
idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
display_namestring or null<= 128 characters^[\w\W]{0,128}$

O nome completo do indivíduo que iniciou o consentimento, conforme fornecido pela instituição.

Exemplo: "Jack Oswald White"
document_numberstring

O número do documento (CPF) do indivíduo.

Exemplo: "76109277673"
belvo_institution_namestring

Nome da instituição de open finance da Belvo à qual o consentimento está relacionado.

Exemplo: "ofmockbank_br_retail"
expired_atstring(date-time)

O timestamp ISO-8601 quando o consentimento irá expirar. No caso de undefined_consent_expiration ser true, este campo será null.

Exemplo: "2021-02-27T13:01:41.941Z"
undefined_consent_expirationboolean

Indique se o consentimento é por um período indefinido, ou seja, se não há expiração para o consentimento.

Exemplo: false
created_atstring(date-time)

O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.

Exemplo: "2022-02-09T08:45:50.406032Z"
statusstring or null

O status do consentimento na rede de open finance. Pode ser:

  • AUTHORISED: O consentimento ainda é válido para uso até a data de expired_at.
  • AWAITING_AUTHORISATION_CONFIRMATION: O usuário deve confirmar dentro da sua instituição.
  • AWAITING_AUTHORISATION: O usuário foi redirecionado para sua instituição para conceder consentimento.
  • REJECTED: O usuário não concedeu consentimento dentro da sua instituição.
  • EXPIRED: O consentimento expirou na data de expired_at.
  • null
Enum"AUTHORISED""AWAITING_AUTHORISATION_CONFIRMATION""AWAITING_AUTHORISATION""REJECTED""EXPIRED"null
Exemplo: "AUTHORISED"
permissionsobject

Detalhes sobre as permissões associadas ao consentimento.

Resposta
application/json
{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "display_name": "Jack Oswald White",
  "document_number": "76109277673",
  "belvo_institution_name": "ofmockbank_br_retail",
  "expired_at": "2021-02-27T13:01:41.941Z",
  "undefined_consent_expiration": false,
  "created_at": "2022-02-09T08:45:50.406032Z",
  "status": "AUTHORISED",
  "permissions": {
    "ACCOUNTS": [ … ],
    "CREDIT_CARDS": [ … ],
    "CREDIT_OPERATIONS": [ … ],
    "REGISTER": [ … ],
    "RESOURCES": [ … ]
  }
}

Owners

Um proprietário representa a pessoa que tem acesso a um Link e é o proprietário de todas as contas dentro do Link.

Você pode usar este endpoint para obter informações úteis sobre seu cliente, como:

  • seu nome completo
  • informações de contato principais
  • informações sobre o documento de identidade que usaram ao abrir a conta
Operações

Accounts

Uma conta é a representação de uma conta bancária dentro de uma instituição financeira. Um usuário pode ter uma ou mais contas em uma instituição.

Por exemplo, um usuário (ou link) pode ter uma conta corrente, vários cartões de crédito e uma conta de empréstimo.

Consultar as informações da conta de um usuário é útil, pois você pode obter informações sobre:

  • quais tipos de contas o usuário possui.
  • o saldo de cada conta (poupança, corrente, cartão de crédito, empréstimo, etc.).
  • informações detalhadas sobre os gastos com cartão de crédito.
  • a situação atual de quaisquer empréstimos que possam ter.
SchemasOperações

Balances

Um saldo é a quantidade de dinheiro disponível em uma determinada conta bancária (corrente ou poupança) em um determinado momento.

SchemasOperações

Exchanges

Uma troca é uma operação de câmbio na Rede de Open Finance do Brasil. O recurso contém detalhes das operações de câmbio, incluindo taxas de câmbio, valores em moedas locais e estrangeiras, e informações de liquidação. Cada operação de câmbio pode ter eventos históricos associados que registram quaisquer modificações no contrato original.

SchemasOperações

Transactions

Uma transação contém as informações detalhadas de cada movimento dentro de uma conta. Por exemplo, uma compra em uma loja ou em um restaurante.

SchemasOperações

Bills

Uma bill refere-se à fatura do cartão de crédito que um usuário recebe para uma determinada conta.

SchemasOperações

Investments Brazil

SchemasOperações

Investment Transactions Brazil

SchemasOperações

Employments Brazil

Nosso recurso de empregos para o Brasil permite que você obtenha uma visão abrangente do histórico de emprego atual e das informações salariais do seu usuário.

Para cada usuário, nós retornamos:

  • histórico de trabalho (incluindo ocupações e dados do empregador)
  • informações salariais históricas e atuais (por empregador)

No momento, o recurso de empregos está disponível para:

  • 🇧🇷 Brasil (INSS)
SchemasOperações

Employment Records Mexico

Nosso recurso de registros de emprego para o México permite que você obtenha uma visão abrangente das contribuições atuais para a seguridade social e do histórico de emprego do seu usuário.

Com o recurso de registros de emprego da Belvo para o México, você pode acessar informações sobre as contribuições atuais para a seguridade social e o histórico de emprego do seu usuário. Para cada usuário, retornamos:

  • dados pessoais
  • histórico de trabalho
  • salário base diário histórico e atual
  • e mais!

No momento, o recurso de registros de emprego está disponível para:

  • 🇲🇽 México (IMSS)
  • 🇲🇽 México (ISSSTE)
SchemasOperações

Current Employments Mexico

O recurso de Empregos Atuais fornece acesso em tempo real ao status de emprego atual de indivíduos no México. Este recurso oferece informações detalhadas sobre se um indivíduo está atualmente empregado ou desempregado, juntamente com seus registros de emprego ativos.

SchemasOperações

Invoices

SchemasOperações

Tax compliance status

SchemasOperações

Tax returns

Operações

Tax retentions

SchemasOperações

Tax status

SchemasOperações

Financial Statements

SchemasOperações

Invoices Chile

SchemasOperações

Tax Status Chile

SchemasOperações

Debt Reports Chile

SchemasOperações

Incomes

Use o endpoint Incomes para obter insights sobre as fontes de renda de uma conta nos últimos 365 dias. O endpoint é particularmente útil quando você deseja verificar a renda de uma pessoa.

📘 Info

O recurso incomes está disponível apenas para contas Corrente e Poupança associadas a links bancários.

SchemasOperações

Recurring Expenses

A API de Despesas Recorrentes da Belvo permite que você identifique os pagamentos regulares de um usuário para serviços de assinatura, como Netflix ou assinaturas de academia, bem como pagamentos de serviços públicos, como contas de eletricidade ou telefone. Nós retornamos informações de até 365 dias.

📘 Informação

O recurso de despesas recorrentes está disponível apenas para contas Corrente, Poupança e de Cartão de Crédito associadas a links bancários.

SchemasOperações

Risk Insights

SchemasOperações

Employment Metrics

SchemasOperações

Payment Institutions (Brazil)

Uma instituição de pagamento é uma entidade da qual a Belvo pode acessar informações. Você pode ver uma lista completa de instituições disponíveis para pagamentos fazendo uma solicitação de List para este endpoint.

Operações

Customers (Brazil)

Um cliente é o pagador que vai transferir fundos para sua conta bancária. Você precisa criar um cliente para receber pagamentos de entrada na conta bancária da sua organização.

Versionamento de Recursos

Este endpoint suporta versionamento a nível de recurso. Ao incluir o cabeçalho X-Belvo-API-Resource-Version: Payments-BR.V2, você pode acessar os formatos de requisição e resposta mais recentes (V2). Se o cabeçalho não for fornecido, o formato padrão (V1) será utilizado. Consulte a documentação da API para detalhes sobre as diferenças entre as versões.

Operações

Bank Accounts (Brazil)

Para receber pagamentos de entrada na conta bancária da sua organização, é necessário registrar as contas bancárias (individuais e empresariais) usando a Payments API da Belvo.

  • Contas bancárias individuais devem ser criadas para cada pagador (seu cliente).
  • Contas bancárias empresariais precisam ser criadas para o beneficiário do pagamento (sua organização).
Versionamento de Recursos

Este endpoint suporta versionamento a nível de recurso. Ao incluir o cabeçalho X-Belvo-API-Resource-Version: Payments-BR.V2, você pode acessar os formatos de requisição e resposta mais recentes (V2). Se o cabeçalho não for fornecido, o formato padrão (V1) será utilizado. Consulte a documentação da API para detalhes sobre as diferenças entre as versões.

Operações

Payment Authorizations (Brazil)

Uma Autorização de Pagamento é o consentimento que seu usuário dá para que você debite dinheiro de suas contas. Você precisa realizar uma Autorização de Pagamento por ‘contrato’ (por exemplo, se sua empresa fornece tanto eletricidade quanto água, mas elas são cobradas separadamente, então você criará duas Autorizações de Pagamento separadas).

Assim que o usuário confirmar a autorização, você precisará escutar um webhook PAYMENT_AUTHORIZATION com o status definido como AUTHORIZED. Assim que você receber esse webhook, o processo de autorização estará completo, e você poderá cobrar seu usuário.

O que é uma cobrança?

Uma cobrança representa o pagamento individual (débito) que seu cliente fará.

Cabeçalho de Versão

O recurso de Autorização de Pagamento requer que você envie o cabeçalho X-Belvo-API-Resource-Version configurado para Payments-BR.V2.

Operações

Charges (Brazil)

Operações

Payment Intents (Brazil)

Uma intenção de pagamento é um ponto único de acesso para criar pagamentos usando qualquer método de pagamento oferecido pela Belvo.

Uma intenção de pagamento captura todas as informações de pagamento (como o valor a ser cobrado, a descrição do pagamento, o provedor, etc.) e guia seus clientes através do fluxo de pagamento.

Operações

Biometric Pix Widget Access Token (Brazil)

Use as solicitações de Token do Biometric Pix Widget para criar um token de acesso para Pagamentos Biométricos.

Operações

Enrollments (Brazil)

Operações

Payment Transactions (Brazil)

Cada vez que você recebe um pagamento de entrada de um cliente, uma transação é criada no banco de dados da Belvo.

Você pode usar o recurso de Transações de Pagamento para obter informações úteis sobre uma transação, bem como a cobrança específica associada a ela.

Operações
Copyright © 2020-2025 Belvo. All rights reserved