Documentação da API Belvo (1.222.0)

Introdução

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:

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 maneira 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, 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).

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 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.

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 Tratamento de Erros.

Política de Repetição

Erros 50x

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).

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 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.

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.

📘 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.

Baixar o arquivo de descrição OpenAPI

BelvoOpenApiSpec.json

BelvoOpenApiSpec.yaml

Visão Geral

URL

https://developers.belvo.com

Need help?

support@belvo.com

Servidores

Mock server

https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/

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.

Operações

Links

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.

Operações

Listar links

Requisição

▶️ Uso

Com o método List Links, você pode:

Listar todos os links relacionados à sua conta Belvo (sem usar parâmetros de consulta).
Obter os detalhes de um link.id específico (usando o parâmetro de consulta id).

📖 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.

idstring(uuid)

Retorne informações apenas para este recurso id.

Exemplo: id=24ccab1d-3a86-4136-a6eb-e04bf52b356f

id__inArray of strings(uuid)

Retorne informações para esses ids de recurso.

Exemplo: id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6

institutionstring[ 1 .. 40 ] characters^[a-z_]{1,40}$

Retorne resultados apenas para esta instituição (use o nome designado pela Belvo, como planet_mx_employment).

Exemplo: institution=planet_mx_retail

institution__inArray of strings

Retorne resultados apenas para estas instituições (use os nomes designados pela Belvo, como ofmockbank_br_retail e planet_mx_employment).

Exemplo: institution__in=planet_mx_retail

access_modestring

Retorne links apenas com este modo de acesso. Pode ser single ou recurrent.

Enum"single""recurrent"

Exemplo: access_mode=single

created_atstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).

Exemplo: created_at=2022-05-05

created_at__gtstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).

Exemplo: created_at__gt=2022-05-05

created_at__gtestring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).

Exemplo: created_at__gte=2022-05-04

created_at__ltstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).

Exemplo: created_at__lt=2022-04-01

created_at__ltestring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).

Exemplo: created_at__lte=2022-03-30

created_at__rangeArray of strings(date)<= 2 items

Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD).

Exemplo: created_at__range=2022-03-03

created_by__not_inArray of strings(uuid)

Retorne links que não foram criados por esses usuários da Belvo.

Exemplo: created_by__not_in=d9475f4d-c511-4732-9ef0-93b5672f43d3

external_idstring[ 3 .. 256 ] characters

Retorne links com este ID externo.

Exemplo: external_id=InternalUser4000

external_id__inArray of strings

Retorne links com esses IDs externos.

Exemplo: external_id__in=InternalUser4001

institution_user_idstring

Retorne links com este ID de usuário específico da instituição.

Exemplo: institution_user_id=ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=

institution_user_id__inArray of strings

Retorne links com esses IDs de usuário da instituição.

Exemplo: institution_user_id__in=ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=

refresh_ratestring^((\d{1,3}h)?(\d{1,3}m)?(\d{1,3}d)?|null)$

Retorne links com esta taxa de atualização. Escolha entre 6h, 12h, 24h, 7d, 30d ou null (para links únicos).

Exemplo: refresh_rate=24h

statusstring

Retorne links com este status. Escolha entre valid, invalid, unconfirmed ou token_required.

Exemplo: status=invalid

status__inArray of strings

Retorne links com esses status. Escolha entre valid, invalid, unconfirmed ou token_required.

Exemplo: status__in=invalid

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/links/?page_size=100&page=1&omit=string&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&institution=planet_mx_retail&institution__in=planet_mx_retail&access_mode=single&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&created_by__not_in=d9475f4d-c511-4732-9ef0-93b5672f43d3&external_id=InternalUser4000&external_id__in=InternalUser4001&institution_user_id=ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0%3D&institution_user_id__in=ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0%3D&refresh_rate=24h&status=invalid&status__in=invalid'

Respostas

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 link.

Resposta

application/json

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

Registrar um novo link

Requisição

▶️ Uso

Registre um novo link (uma conexão entre seu usuário e sua instituição) usando a API da Belvo.

👍 Recomendamos fortemente o uso do nosso Connect Widget para gerenciar a criação de links e atualizações de status de links.

Para facilitar, incluímos exemplos personalizados para os links que você pode criar para cada um dos nossos produtos. Basta clicar no tipo de link que você deseja criar na seção Body Params abaixo.

Segurança

basicAuth

Corpoapplication/jsonobrigatório

One of:

O corpo da solicitação para criar um link para instituições de emprego no Brasil.

institutionstring[a-z]+_[a-z]{2}_[a-z]+obrigatório

O nome Belvo para a instituição. Para instituições de emprego no Brasil, você pode selecionar as seguintes instituições:

inss_br_employment

Exemplo: "inss_br_employment"

usernamestring^^(\d{11}$)|(\d{3}\.){2}\d{3}(-\d{2})$obrigatório

O CPF (ID) do usuário usado para fazer login na instituição. Você pode fornecê-lo com 11 caracteres ou no formato XXX.XXX.XXX-XX.

Exemplo: "231.002.999-00"

passwordstring(password)^.{8,70}$obrigatório

A senha do usuário usada para fazer login na instituição.

Exemplo: "1234B789C234AGH"

external_idstring[ 3 .. 256 ] characters

Um identificador adicional para o link, fornecido por você, para armazenar no banco de dados da Belvo. Não pode incluir nenhuma Informação Pessoal Identificável (PII). Deve ter pelo menos três caracteres.

Se identificarmos que o identificador contém PII, forçaremos um valor null. Para mais informações, consulte nosso artigo sobre criação de links.

Exemplo: "56ab5706-6e00-48a4-91c9-ca55968678d9"

access_modestring

O tipo de link a ser criado.

Use single para fazer requisições POST ad hoc únicas para contas, proprietários e transações.
Use recurrent para que o Belvo acesse informações de forma recorrente, garantindo que você sempre tenha dados atualizados de contas, proprietários, saldos e transações.

Para mais informações, consulte nosso artigo de Links.

Padrão "recurrent"

Enum"single""recurrent"

fetch_resourcesArray of strings

Uma matriz de recursos para os quais você gostaria de receber uma atualização histórica.

Para instituições de emprego, você pode selecionar os seguintes recursos:

OWNERS
EMPLOYMENTS

Exemplo: ["OWNERS","EMPLOYMENTS"]

credentials_storagestring^(store|nostore|\d{1,3}d)$

Indica se as credenciais devem ou não ser armazenadas (e a duração para a qual as credenciais serão armazenadas).

Para links recorrentes, isso é definido como store por padrão (e não pode ser alterado).
Para links únicos, isso é definido como 365d por padrão.

Pode ser:

store para armazenar credenciais (até que o link seja excluído)
nostore para não armazenar credenciais
Qualquer valor entre 1d e 365d para indicar o número de dias que você deseja que as credenciais sejam armazenadas.

Para mais informações, confira a seção credentials_storage do nosso artigo sobre controles de retenção de dados.

Exemplo: "27d"

stale_instring^\d{1,3}d$

Indica por quanto tempo qualquer dado derivado do usuário deve ser armazenado no banco de dados da Belvo para o link (tanto único quanto recorrente). Por exemplo, se você enviar 90d, a Belvo removerá qualquer dado relacionado ao usuário de seu banco de dados após 90 dias. Para mais informações, confira a seção stale_in do nosso artigo sobre controles de retenção de dados.

📘 Informação
A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in. A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in.

Por padrão, a Belvo armazena dados do usuário por 365 dias, a menos que o link seja deletado.

Exemplo: "42d"

curl -i -X POST \
  -u <username>:<password> \
  https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/links/ \
  -H 'Content-Type: application/json' \
  -d '{
    "institution": "inss_br_employment",
    "username": "231.002.999-00",
    "password": "1234B789C234AGH",
    "external_id": "56ab5706-6e00-48a4-91c9-ca55968678d9",
    "access_mode": "single",
    "fetch_resources": [
      "OWNERS",
      "EMPLOYMENTS"
    ],
    "credentials_storage": "27d",
    "stale_in": "42d"
  }'

Respostas

Criado

Corpoapplication/json

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

institutionstring

Nome da instituição segundo a Belvo.

Exemplo: "erebor_mx_retail"

access_modestring or null

O tipo de link. Para mais informações, consulte nosso artigo de Links. Retornamos um dos seguintes valores enum: - single - recurrent - null

Enum"single""recurrent"null

Exemplo: "recurrent"

last_accessed_atstring or null(date-time)

O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.

Exemplo: "2021-03-09T10:28:40.000Z"

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"

external_idstring[ 3 .. 256 ] characters

Se identificarmos que o identificador contém PII, forçaremos um valor null. Para mais informações, consulte nosso artigo sobre criação de links.

Exemplo: "56ab5706-6e00-48a4-91c9-ca55968678d9"

institution_user_idstring[A-Za-z0-9\-=_]{44}

📘 Info
Aplicável apenas para links criados após 08-02-2022.

Uma string única de 44 caracteres que pode ser usada para identificar um usuário em uma determinada instituição.

📚 Confira nosso artigo no DevPortal sobre como evitar links duplicados para mais informações e dicas sobre como usá-la.

Exemplo: "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c="

statusstring

O status atual do link. Para mais informações, consulte nosso artigo sobre Link no devportal.
Retornamos um dos seguintes valores:

valid
invalid
unconfirmed
token_required

Enum"valid""invalid""unconfirmed""token_required"

Exemplo: "valid"

created_bystring(uuid)

O ID único para o usuário que criou este item.

Exemplo: "bcef7f35-67f2-4b19-b009-cb38795faf09"

refresh_ratestring or null

A taxa de atualização para o link recorrente. Para mais informações, consulte nossa documentação de links recorrentes em nosso DevPortal. Retornamos um dos seguintes valores de enum:

6h
12h
24h
7d (padrão)
30d (uma vez por mês)
null (para links únicos)

Padrão "7d"

Enum"6h""12h""24h""7d""30d"null

Exemplo: "7d"

credentials_storagestring^(store|nostore|\d{1,3}d)$

Indica se as credenciais devem ou não ser armazenadas (e a duração para a qual as credenciais serão armazenadas).

Para links recorrentes, isso é definido como store por padrão (e não pode ser alterado).
Para links únicos, isso é definido como 365d por padrão.

Pode ser:

store para armazenar credenciais (até que o link seja excluído)
nostore para não armazenar credenciais
Qualquer valor entre 1d e 365d para indicar o número de dias que você deseja que as credenciais sejam armazenadas.

Para mais informações, confira a seção credentials_storage do nosso artigo sobre controles de retenção de dados.

Exemplo: "27d"

fetch_resourcesArray of strings

Um array de recursos para o qual você receberá uma atualização histórica.

Exemplo: ["ACCOUNTS","TRANSACTIONS"]

stale_instring^\d{1,3}d$

📘 Informação
A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in. A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in.

Por padrão, a Belvo armazena dados do usuário por 365 dias, a menos que o link seja deletado.

Exemplo: "42d"

Resposta

application/json

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "institution": "erebor_mx_retail",
  "access_mode": "recurrent",
  "last_accessed_at": "2021-03-09T10:28:40.000Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "external_id": "56ab5706-6e00-48a4-91c9-ca55968678d9",
  "institution_user_id": "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c=",
  "status": "valid",
  "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
  "refresh_rate": "7d",
  "credentials_storage": "27d",
  "fetch_resources": [
    "ACCOUNTS",
    "TRANSACTIONS"
  ],
  "stale_in": "42d"
}

Solicitação completa de links

Requisição

Usado para retomar uma sessão de registro de Link que foi pausada porque um token MFA foi exigido pela instituição.

Segurança

basicAuth

Corpoapplication/jsonobrigatório

sessionstring[a-f0-9]{32}obrigatório

A sessão que você deseja retomar. Você precisa usar o valor session que é fornecido na resposta 428 Token Required que você recebe após fazer sua solicitação POST.

Exemplo: "6e7b283c6efa449c9c028a16b5c249fa"

tokenstring

O token MFA gerado pela instituição, que é necessário para continuar uma sessão.

Exemplo: "1234ab"

linkstring(uuid)obrigatório

O link.id que você deseja retomar. Deve ser o mesmo link.id que você recebe na resposta 428 Token Required que contém o ID da session.

Exemplo: "683005d6-f45c-4adb-b289-f1a12f50f80c"

save_databoolean

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.

Padrão true

Exemplo: true

curl -i -X PATCH \
  -u <username>:<password> \
  https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/links/ \
  -H 'Content-Type: application/json' \
  -d '{
    "session": "6e7b283c6efa449c9c028a16b5c249fa",
    "token": "1234ab",
    "link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
    "save_data": true
  }'

Respostas

Corpoapplication/json

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

institutionstring

Nome da instituição segundo a Belvo.

Exemplo: "erebor_mx_retail"

access_modestring or null

O tipo de link. Para mais informações, consulte nosso artigo de Links. Retornamos um dos seguintes valores enum: - single - recurrent - null

Enum"single""recurrent"null

Exemplo: "recurrent"

last_accessed_atstring or null(date-time)

O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.

Exemplo: "2021-03-09T10:28:40.000Z"

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"

external_idstring[ 3 .. 256 ] characters

Se identificarmos que o identificador contém PII, forçaremos um valor null. Para mais informações, consulte nosso artigo sobre criação de links.

Exemplo: "56ab5706-6e00-48a4-91c9-ca55968678d9"

institution_user_idstring[A-Za-z0-9\-=_]{44}

📘 Info
Aplicável apenas para links criados após 08-02-2022.

Uma string única de 44 caracteres que pode ser usada para identificar um usuário em uma determinada instituição.

📚 Confira nosso artigo no DevPortal sobre como evitar links duplicados para mais informações e dicas sobre como usá-la.

Exemplo: "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c="

statusstring

O status atual do link. Para mais informações, consulte nosso artigo sobre Link no devportal.
Retornamos um dos seguintes valores:

valid
invalid
unconfirmed
token_required

Enum"valid""invalid""unconfirmed""token_required"

Exemplo: "valid"

created_bystring(uuid)

O ID único para o usuário que criou este item.

Exemplo: "bcef7f35-67f2-4b19-b009-cb38795faf09"

refresh_ratestring or null

A taxa de atualização para o link recorrente. Para mais informações, consulte nossa documentação de links recorrentes em nosso DevPortal. Retornamos um dos seguintes valores de enum:

6h
12h
24h
7d (padrão)
30d (uma vez por mês)
null (para links únicos)

Padrão "7d"

Enum"6h""12h""24h""7d""30d"null

Exemplo: "7d"

credentials_storagestring^(store|nostore|\d{1,3}d)$

Indica se as credenciais devem ou não ser armazenadas (e a duração para a qual as credenciais serão armazenadas).

Para links recorrentes, isso é definido como store por padrão (e não pode ser alterado).
Para links únicos, isso é definido como 365d por padrão.

Pode ser:

store para armazenar credenciais (até que o link seja excluído)
nostore para não armazenar credenciais
Qualquer valor entre 1d e 365d para indicar o número de dias que você deseja que as credenciais sejam armazenadas.

Para mais informações, confira a seção credentials_storage do nosso artigo sobre controles de retenção de dados.

Exemplo: "27d"

fetch_resourcesArray of strings

Um array de recursos para o qual você receberá uma atualização histórica.

Exemplo: ["ACCOUNTS","TRANSACTIONS"]

stale_instring^\d{1,3}d$

📘 Informação
A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in. A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in.

Por padrão, a Belvo armazena dados do usuário por 365 dias, a menos que o link seja deletado.

Exemplo: "42d"

Resposta

application/json

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "institution": "erebor_mx_retail",
  "access_mode": "recurrent",
  "last_accessed_at": "2021-03-09T10:28:40.000Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "external_id": "56ab5706-6e00-48a4-91c9-ca55968678d9",
  "institution_user_id": "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c=",
  "status": "valid",
  "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
  "refresh_rate": "7d",
  "credentials_storage": "27d",
  "fetch_resources": [
    "ACCOUNTS",
    "TRANSACTIONS"
  ],
  "stale_in": "42d"
}

Consents

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

Operações

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.

Operações

Balances

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

Operaçõ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.

Operações

Bills

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

Operações

Investments Brazil

Operações

Investment Transactions Brazil

Operaçõ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)

Operaçõ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)

Operaçõ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.

Operações

Invoices

Operações

Tax compliance status

Operações

Tax returns

Operações

Tax retentions

Operações

Tax status

Operações

Financial Statements

Operações

Invoices Chile

Operações

Tax Status Chile

Operações

Debt Reports Chile

Operaçõ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.

Operaçõ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.

Operações

Risk Insights

Operações

Employment Metrics

Operaçõ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

Operações

Payment Links (Brazil)

Este é um link de pagamento.

Operações

Payment Intents (Brazil)

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_type no array form_fields, você deve enviar esse valor na sua solicitação PATCH.

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

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

Documentação da API Belvo (1.222.0)

Introdução

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

Dicionários de Dados

Ambientes

Sandbox

Produção

Códigos de Resposta

Tratamento de Erros

Identificador de Solicitação

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

Política de Repetição

Erros 50x

Erros 40x

Campos Obsoletos

OpenAPI: campos obrigatórios e anuláveis

Institutions

Links

Listar links

Requisição

▶️ Uso

📖 Paginação

🔦 Filtrando Respostas

Respostas

Quão útil foi esta página?

Registrar um novo link

Requisição

▶️ Uso

Respostas

Quão útil foi esta página?

Solicitação completa de links

Requisição

Respostas

Quão útil foi esta página?

Widget Access Token

Consents

Owners

Accounts

Balances

Transactions

Bills

Investments Brazil

Investment Transactions Brazil

Employments Brazil

Employment Records Mexico

Current Employments Mexico

Invoices

Tax compliance status

Tax returns

Tax retentions

Tax status

Financial Statements

Invoices Chile

Tax Status Chile

Debt Reports Chile

Incomes

Recurring Expenses

Risk Insights

Employment Metrics

Payment Institutions (Brazil)

Customers (Brazil)

Bank Accounts (Brazil)

Payment Links (Brazil)

Payment Intents (Brazil)

Payment Authorizations (Brazil)

Biometric Pix Widget Access Token (Brazil)

Enrollments (Brazil)

Payment Transactions (Brazil)