URL
Need help?
Alcance novos públicos e converta mais usuários conectando-se fácil e seguramente aos dados financeiros deles, entendendo seu comportamento e possibilitando pagamentos instantâneos com open finance. Através da nossa API, você pode acessar:
A Belvo é uma API de open banking para a América Latina que permite que empresas acessem informações bancárias e fiscais de maneira segura e ágil.
Através da nossa API, você pode acessar:
Você também pode usar nossa API para realizar pagamentos em:
Se você deseja a documentação de resposta em formato Excel ou CSV, por favor, faça o download a partir 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).
Disponível para:
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.
Disponível para:
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 é:
sandbox.belvo.com para api.belvo.com.Usamos o seguinte código de status HTTP na resposta, dependendo do sucesso ou falha:
| Código de Status | Descriçã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. |
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.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.
Para uma lista completa de erros e como solucioná-los, consulte nosso artigo dedicado Tratamento de Erros.
Implemente uma repetição automática exponencial de até cinco tentativas. Recomendamos usar um intervalo base de três segundos com um fator de dois. Por exemplo, a primeira repetição deve ser após três segundos, a segunda repetição após seis segundos (2 * 3), a terceira repetição após 12 segundos (2 * 6), a quarta repetição após 24 segundos (2 * 12) e a quinta repetição após 48 segundos (2 * 24).
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 isso significa que seu usuário final está acessando a conta de outro navegador ao mesmo tempo. Nesse caso, implemente a mesma política de repetição que para erros 50x.
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.
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.
📘 Informação
Em resumo, qualquer parâmetro de resposta marcado como obrigatório será retornado pela nossa API, mas o valor pode ser definido como nulo.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/
https://sandbox.belvo.com/
Uma instituição é uma entidade da qual a Belvo pode acessar informações. Pode ser uma:
Um Link é um conjunto de credenciais associado ao acesso de um usuário final a uma instituição. Você precisará registrar um Link antes de acessar informações desse usuário final específico, como detalhes de conta ou transações.
Recomendamos usar o Belvo Hosted Widget para gerenciar o processo de conexão.
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:
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:
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:
No momento, o recurso de empregos está disponível para:
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:
No momento, o recurso de registros de emprego está disponível para:
Com o método List Tax Returns, você pode:
link.id específico (usando o parâmetro de consulta link).tax-return.id específico (usando o parâmetro de consulta id).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.
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.
Como um link pode ter declarações de imposto anuais e mensais, a resposta incluirá uma mistura desses dois tipos de declarações de imposto (e, portanto, diferentes esquemas).
O link.id pelo qual você deseja filtrar.
ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.
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).
Um número de página dentro do conjunto de resultados paginados.
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
Retorne resultados apenas para esses link.ids.
Retorne informações apenas para este recurso id.
Retorne informações para esses ids de recurso.
Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD).
Retorne declarações de imposto exatamente para este ano (YYYY).
Retorne declarações de imposto de anos anteriores a este ano (YYYY).
Retorne declarações de imposto para este ano e anteriores (YYYY).
Retornar declarações de imposto para depois deste ano (YYYY).
Retorne declarações de imposto para este ano ou posterior (YYYY).
Retorne declarações de imposto para este intervalo de anos (YYYY).
Retorne declarações de impostos com este tipo de declaração.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/
https://sandbox.belvo.com/api/tax-returns/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/?created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03&ejercicio=2017&ejercicio__gt=2017&ejercicio__gte=2017&ejercicio__lt=2017&ejercicio__lte=2017&ejercicio__range=2017&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&omit=string&page=1&page_size=100&tipo_declaracion=Normal&tipo_declaracion__in=Commercial'Ok
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).
A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.
Um array de:
🚧 Múltiplos Schemas
Como um link pode ter declarações de imposto tanto anuais quanto mensais, a resposta incluirá uma mistura desses dois tipos de declarações de imposto (e, portanto, diferentes schemas).
Exemplo de uma lista de declarações de imposto de renda pessoal
{ "count": 101, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ { … } ] }
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
Corpo da solicitação para declarações de impostos mensais
O link.id para o qual você deseja recuperar informações.
Quando definido como true, você receberá o PDF em formato binário na resposta.
Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como true e retornamos uma resposta 201 Created.
Quando definido como false, os dados não serão persistidos e retornamos uma resposta 200 OK.
O tipo de declaração de imposto a ser retornada. Para declarações de imposto mensais, este campo deve ser definido como monthly.
A data a partir da qual você deseja começar a obter dados, no formato YYYY-MM-DD.
⚠️ O valor de date_from não pode ser maior que date_to.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/
https://sandbox.belvo.com/api/tax-returns/
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"attach_pdf": true,
"save_data": true,
"type": "monthly",
"date_from": "2020-08-05",
"date_to": "2020-10-05"
}'Ok (quando save_data=false)
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
Informações gerais sobre a declaração de imposto (ano, RFC, tipo de declaração, nome da pessoa/empresa, etc.).
Detalhes sobre as informações de renda juntamente com os impostos retidos.
Detalhes sobre a renda e informações fiscais provenientes de serviços profissionais prestados.
Declaração de imposto em PDF como binário.
O recibo de confirmação da instituição fiscal confirmando que eles receberam a declaração de imposto.
Exemplo de uma lista de declarações de imposto de renda pessoal
[ { "id": "02589c41-ba22-4d44-8558-8111cc751318", "link": "19697249-01b8-443e-a451-76bfc5fbeebf", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "informacion_general": { … }, "sueldos_salarios": { … }, "servicios_profesionales": { … }, "deducciones_personales": { … }, "determinacion_impuesto": { … }, "retenciones": { … }, "dividendos": { … }, "datos_informativos": { … }, "pdf": "=PDF-STRING=", "receipt_pdf": "=PDF-STRING=" } ]
Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.
Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/{id}/
https://sandbox.belvo.com/api/tax-returns/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/tax-returns/{id}/?fields=string&omit=string'Ok
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
Informações gerais sobre a declaração de imposto (ano, RFC, tipo de declaração, nome da pessoa/empresa, etc.).
Detalhes sobre as informações de renda juntamente com os impostos retidos.
Detalhes sobre a renda e informações fiscais provenientes de serviços profissionais prestados.
Declaração de imposto em PDF como binário.
O recibo de confirmação da instituição fiscal confirmando que eles receberam a declaração de imposto.
Exemplo de uma lista de declarações de imposto de renda pessoal
{ "id": "02589c41-ba22-4d44-8558-8111cc751318", "link": "19697249-01b8-443e-a451-76bfc5fbeebf", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "informacion_general": { "ejercicio": 2018, "fecha_hora_presentacion": "2020-01-07T17:28:00-05:00", "numero_operacion": "00000000001", "periodo_declaracion": "Del Ejercicio", "rfc": "ABCD111111A11", "tipo_declaracion": "Normal", "nombre": "JOHN DOE" }, "sueldos_salarios": { "retenedores": [ … ], "impuesto_retenido": 19497, "ingreso_anual": 118263, "ingresos_acumulables": 115998, "ingresos_exentos": 2265, "subsidio_empleo": 0 }, "servicios_profesionales": { "deducciones_autorizadas": { … }, "ingresos": { … }, "resultado_fiscal": { … }, "pagos_provisionales": { … }, "retenciones_isr": { … } }, "deducciones_personales": { "honorarios_medicos_dentales_hospitalarios": [ … ], "donativos": [ … ], "aportaciones_voluntarias_complementarias_al_sar": [ … ], "primas_por_seguros_de_gasto_medico": [ … ] }, "determinacion_impuesto": { "base_gravable": 126864, "deducciones_personales": 23264, "ingresos_acumulables": 150128, "isr_favorable": 10308, "isr_conforme_tarifa_final": 13789, "isr_retenido": 24097, "num_clabe": "000000000000000001", "nombre_banco": "BANCO SA", "pagos_provisionales": 0, "titular_clabe_permite_verificacion": "SÍ", "accion_saldo_a_favor": "DEVOLUCIÓN" }, "retenciones": { "sueldos_salarios": [ … ], "dividendos": [], "servicios_profesionales": [ … ] }, "dividendos": { "monto_acumulable_dividendos_utilidades": null, "monto_total_isr_pagado_sociedad": null }, "datos_informativos": { "credito_fiscal_autorizado_proyectos_investigacion_desarrollo": 0, "credito_fiscal_autorizado_proyectos_apoyo_deporte_alto_rendimiento": 0, "credito_fiscal_autorizado_proyectos_inversion_artes": 0, "credito_fiscal_autorizado_inversion_equipos_fijos": 0, "credito_fiscal_autorizado_produccion_distribucion_cinematografica": 0, "saldo_credito_fiscal_autorizado_anteriores_investigacion_desarrollo": 0, "saldo_credito_fiscal_anteriores_proyectos_inversion_artes": 0, "saldo_credito_fiscal_anteriores_produccion_distribucion_cinematografica": 0 }, "pdf": "=PDF-STRING=", "receipt_pdf": "=PDF-STRING=" }
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.
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.
Para receber pagamentos de entrada na conta bancária da sua organização, você deve registrar as contas bancárias (individuais e empresariais) usando a Payments API da Belvo.
Um payment intent é um ponto único de acesso para criar pagamentos usando qualquer método de pagamento oferecido pela Belvo.
Um payment intent 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.
Nota: Para instituições que exigem o
username_typeno arrayform_fields, você deve enviar esse valor na sua solicitação PATCH.