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

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.

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

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

Objeto de Despesas Recorrentes

Insights sobre despesas recorrentes.

ℹ️ Se nenhuma informação sobre despesas recorrentes for encontrada, retornamos um array vazio.

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
accountobject or nullobrigatório

Detalhes sobre a conta.

Nota: Para o nosso recurso de despesas recorrentes, esta conta está relacionada à conta que foi analisada para gerar o relatório de despesas recorrentes.

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
institutionobject

Detalhes sobre a instituição.

collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
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"
categorystring or nullobrigatório

O tipo de conta.
Retornamos um dos seguintes valores do enum:

  • CHECKING_ACCOUNT
  • CREDIT_CARD
  • INVESTMENT_ACCOUNT
  • LOAN_ACCOUNT
  • PENSION_FUND_ACCOUNT
  • SAVINGS_ACCOUNT
  • UNCATEGORIZED
  • null
Enum"CHECKING_ACCOUNT""CREDIT_CARD""INVESTMENT_ACCOUNT""LOAN_ACCOUNT""PENSION_FUND_ACCOUNT""SAVINGS_ACCOUNT""UNCATEGORIZED"null
Exemplo: "CHECKING_ACCOUNT"
balance_typestring or nullobrigatório

Indica se esta conta é um ASSET ou um LIABILITY. Você pode considerar o saldo de um ASSET como positivo, enquanto o saldo de um LIABILITY como negativo.

Exemplo: "ASSET"
typestring or nullobrigatório

O tipo de conta, conforme designado pela instituição.

Exemplo: "Cuentas de efectivo"
namestring or nullobrigatório

O nome da conta, conforme fornecido pela instituição.

Exemplo: "Cuenta Perfiles- M.N. - MXN-666"
numberstring or nullobrigatório

O número da conta, conforme designado pela instituição.

Exemplo: "4057068115181"
balanceobjectobrigatório

Detalhes sobre os saldos atual e disponível para a conta.

currentnumber or null(float)obrigatório

O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.

  • 💰 Contas correntes e poupança:

O saldo da conta do usuário no timestamp collected_at.

  • 💳 Cartões de crédito:

O valor que o usuário gastou no período de faturamento atual do cartão (consulte credit_data.cutting_date para informações sobre quando o período de faturamento atual termina).

  • 🏡 Contas de empréstimo:

O valor restante a pagar no empréstimo do usuário.

Exemplo: 5874.13
availablenumber or null(float)

O saldo que o proprietário da conta pode usar.

  • 💰 Contas correntes e poupança:

O saldo disponível pode ser diferente do saldo current devido a transações pendentes.

  • 💳 Cartões de crédito:

O valor de crédito que o usuário ainda tem disponível para o período atual. O saldo available pode ser diferente do saldo current devido a transações pendentes ou parcelas futuras.

  • 🏡 Contas de empréstimo:

O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição.

Nota: Se a instituição não fornecer este valor, retornamos null.

Exemplo: 5621.12
currencystring or nullobrigatório

A moeda da conta. Por exemplo:

  • 🇧🇷 BRL (Real Brasileiro)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)

Por favor, note que outras moedas além das listadas acima podem ser retornadas.

Exemplo: "MXN"
public_identification_namestring or nullobrigatório

O nome público para o tipo de identificação. Por exemplo: "CLABE".

ℹ️ Para contas de poupança e corrente 🇧🇷 brasileiras, este campo será AGENCY/ACCOUNT.

Exemplo: "CLABE"
public_identification_valuestring or nullobrigatório

O valor para o public_identification_name.

ℹ️ Para contas de poupança e corrente brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: 0444/45722-0.

Exemplo: "150194683119900273"
last_accessed_atstring or null(date-time)obrigatório

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"
credit_dataobject or nullobrigatório

As opções de crédito associadas a esta conta.

credit_limitnumber or null(float)obrigatório

O valor máximo de crédito que o proprietário pode receber.

Exemplo: 192000
collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
cutting_datestring or nullobrigatório

A data de encerramento do período de crédito, no formato YYYY-MM-DD.

Exemplo: "2019-12-11"
next_payment_datestringobrigatório

A data de vencimento para o próximo pagamento, no formato YYYY-MM-DD.

Exemplo: "2019-12-13"
minimum_paymentnumber or null(float)obrigatório

O valor mínimo a ser pago na next_payment_date.

Exemplo: 2400.3
no_interest_paymentnumber or null(float)obrigatório

O valor mínimo necessário para pagar para evitar a geração de juros.

Exemplo: 2690.83
interest_ratenumber or null(float)obrigatório

A taxa de juros anualizada do crédito.

Exemplo: 4
monthly_paymentnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O pagamento mensal recorrente, se aplicável.

Exemplo: null
last_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data em que o último pagamento de crédito foi realizado, no formato YYYY-MM-DD.

Exemplo: null
last_period_balancestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O saldo restante após o last_payment_date.

Exemplo: null
loan_dataobject or nullobrigatório

As opções de empréstimo associadas a esta conta.

collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
contract_amountnumber or null(float)

O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas.

Exemplo: 202000
principalnumber or null(float)obrigatório

Valor total do empréstimo (o valor que o usuário recebe).

Exemplo: 192000
loan_typestring or null

O tipo do empréstimo, de acordo com a instituição.

Exemplo: "Consignado"
payment_daystring or null

O dia do mês em que o proprietário precisa pagar o empréstimo (DD).

Exemplo: "27"
outstanding_principalnumber or null(float)

Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros).

Exemplo: 142023
outstanding_balancenumber or null(float)obrigatório

O valor restante a pagar no total, incluindo juros.

Exemplo: 182000
monthly_paymentnumber or null(float)obrigatório

O pagamento mensal recorrente, se aplicável.

Exemplo: 1000
interest_ratesArray of objects or nullobrigatório

Detalhamento dos juros aplicados ao empréstimo.

namestring or nullobrigatório

O nome do tipo de taxa de juros aplicada ao empréstimo.

Exemplo: "jurosEfetivo"
typestring or nullobrigatório

O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores:

  • MONTHLY
  • YEARLY
Enum"MONTHLY""YEARLY"
Exemplo: "MONTHLY"
valuenumber or null(float)obrigatório

A taxa de juros (em porcentagem ou valor monetário).

Exemplo: 7.85
feesArray of objects or null or null

Detalhamento das taxas aplicadas ao empréstimo.

number_of_installments_totalinteger or null(int32)

O número total de parcelas necessárias para pagar o empréstimo.

Exemplo: 60
number_of_installments_outstandinginteger or null(int32)

O número de parcelas restantes para pagar.

Exemplo: 48
contract_start_datestring or null

A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.

Exemplo: "2020-03-01"
contract_end_datestring(date)

A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.

Exemplo: "2027-10-01"
contract_numberstring or null

O número do contrato do empréstimo, conforme fornecido pela instituição.

Exemplo: "890ASLDJF87SD00"
credit_limitnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte principal em vez disso.

Exemplo: null
last_period_balancenumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte outstanding_balance em vez disso.

Exemplo: null
interest_ratenumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte o objeto interest_rates.

Exemplo: null
limit_daystring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Consulte payment_day em vez disso.

Exemplo: null
cutting_daystring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre campos descontinuados.

O dia de fechamento do mês para o empréstimo.

Exemplo: null
cutting_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data de encerramento do período do empréstimo, no formato YYYY-MM-DD.

Exemplo: null
last_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data em que o último pagamento do empréstimo foi realizado, no formato YYYY-MM-DD.

next_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, use payment_day em vez disso, no formato YYYY-MM-DD.

Exemplo: null
no_interest_paymentnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O valor mínimo necessário para pagar e evitar a geração de juros.

Exemplo: null
funds_dataArray of objects or null

Um ou mais fundos que contribuem para a conta de pensão.

bank_product_idstring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuações, consulte nossa explicação sobre Campos descontinuados.

O ID de produto da instituição para o tipo de conta.

Exemplo: null
internal_identificationstring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Identificação interna da instituição para a conta.

Exemplo: null
namestring or nullobrigatório

O nome para a despesa recorrente.

ℹ️ Nota: Esta informação é retirada da seção de descrição de uma transação e, em seguida, normalizada para fornecer um nome de fácil leitura. Assim, às vezes o nome refletirá o comerciante para o qual o pagamento é feito (por exemplo, Netflix.com), enquanto para outras despesas recorrentes, isso pode ser algo como "Pagamento mensal para John".

Padrão null
Exemplo: "Netflix"
transactionsArray of objects or nullobrigatório

Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio.

amountnumber(float)obrigatório

O valor da transação.

Exemplo: 2145.45
descriptionstring or nullobrigatório

A descrição da transação fornecida pela instituição. Normalmente, este é o texto que o usuário final veria no extrato bancário. A descrição pode ser uma string vazia.

Nota: Para o EYOD Risk Insights, a descrição é aquela que você forneceu na solicitação inicial.

Exemplo: "Netflix.com/march"
value_datestring(date)obrigatório

A data em que a transação ocorreu, no formato YYYY-MM-DD.

Exemplo: "2019-10-23"
frequencystringobrigatório

A frequência com que essa despesa recorrente ocorre.

ℹ️ Nota: A Belvo identifica apenas frequências MONTHLY.

Padrão "MONTHLY"
Valor"MONTHLY"
Exemplo: "MONTHLY"
average_transaction_amountnumber(float)obrigatório

O valor médio da transação da despesa recorrente.

Exemplo: 32.9
median_transaction_amountnumber(float)obrigatório

O valor mediano da transação da despesa recorrente.

Exemplo: 32.9
days_since_last_transactioninteger(int32)obrigatório

Número de dias desde que a última despesa recorrente ocorreu.

Com base na frequência, você pode inferir quantos dias faltam até que a próxima cobrança ocorra.

Exemplo: 5
categorystringobrigatório

A categoria de transação para a despesa recorrente. Para mais informações sobre as categorias disponíveis, consulte nossa documentação de categorização de transações.

  • Online Platforms & Leisure (Netflix, Spotify, Assinaturas de Academia)
  • Bills & Utilities (eletricidade, telefone, internet)
  • Credits & Loans (adiantamentos de cartão de crédito, empréstimo estudantil, leasing de embarcações)
  • Insurance (seguro residencial, automotivo, e de saúde & vida)
  • Transport & Travel (viagem de Uber, airbnb, estacionamento)
  • Taxes (taxa de serviço, doação, impostos judiciais)
Enum"Bills & Utilities""Credits & Loans""Insurance""Online Platforms & Leisure""Transport & Travel""Taxes"
Exemplo: "Online Platforms & Leisure"
payment_typestring or nullobrigatório

O tipo de despesa recorrente. Retornamos um dos seguintes valores:

  • SUBSCRIPTION
  • REGULAR
Enum"SUBSCRIPTION""REGULAR"
Exemplo: "SUBSCRIPTION"
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "account": { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "institution": {}, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "category": "CHECKING_ACCOUNT", "balance_type": "ASSET", "type": "Cuentas de efectivo", "name": "Cuenta Perfiles- M.N. - MXN-666", "number": "4057068115181", "balance": {}, "currency": "MXN", "public_identification_name": "CLABE", "public_identification_value": "150194683119900273", "last_accessed_at": "2021-03-09T10:28:40.000Z", "credit_data": {}, "loan_data": {}, "funds_data": [], "bank_product_id": null, "internal_identification": null }, "name": "Netflix", "transactions": [ {} ], "frequency": "MONTHLY", "average_transaction_amount": 32.9, "median_transaction_amount": 32.9, "days_since_last_transaction": 5, "category": "Online Platforms & Leisure", "payment_type": "SUBSCRIPTION" }

Listar despesas recorrentes

Requisição

▶️ Uso

Com o método Listar Despesas Recorrentes, você pode:

  1. Listar despesas recorrentes relacionadas a um link.id específico (usando o parâmetro de consulta link).
  2. Obter os detalhes de um recurring-expense.id específico (usando o parâmetro de consulta id).
  3. [Não Recomendado] Listar todas as despesas recorrentes relacionadas à 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, consulte nosso artigo Filtrando respostas.

Security
basicAuth
Consulta
linkstring(uuid)

O link.id pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.

Exemplo: link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4
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.

link__inArray of strings(uuid)

Retorne resultados apenas para esses link.ids.

Exemplo: link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6
accountstring(uuid)

O account.id pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar os filtros link.id ou account.id para melhorar seu desempenho.

Exemplo: account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4
account__inArray of strings(uuid)

Retorne resultados apenas para esses account.ids.

Exemplo: account__in=85b77707-90ef-46fd-9059-5a757f24247a
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
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/recurring-expenses/?account=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&account__in=85b77707-90ef-46fd-9059-5a757f24247a&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'

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

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

Recuperar despesas recorrentes para um link

Requisição

Recupere insights de despesas recorrentes para contas correntes e de poupança a partir de um link específico. Você pode receber insights para um período de até 365 dias, dependendo do histórico de transações disponível para cada instituição.

Security
basicAuth
Consulta
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.

Corpoapplication/jsonobrigatório
linkstring(uuid)obrigatório

O link.id para o qual você deseja recuperar informações.

Exemplo: "c81a1dea-6dd6-4999-8b9f-541ee8197058"
tokenstring

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

Exemplo: "1234ab"
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
date_fromstring(date)= 10 characters^\d{4}-\d{2}-\d{2}$

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.

Exemplo: "2020-08-05"
date_tostring(date)= 10 characters^\d{4}-\d{2}-\d{2}$

A data em que você deseja parar de receber dados, no formato YYYY-MM-DD.

⚠️ O valor de date_to não pode ser maior que a data de hoje (ou seja, não são permitidas datas futuras).

Exemplo: "2020-10-05"
curl -i -X POST \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/recurring-expenses/?fields=string&omit=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
    "token": "1234ab",
    "save_data": true,
    "date_from": "2020-08-05",
    "date_to": "2020-10-05"
  }'

Respostas

Ok (quando save_data=false)

Corpoapplication/jsonArray [
idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
accountobject or nullobrigatório

Detalhes sobre a conta.

Nota: Para o nosso recurso de despesas recorrentes, esta conta está relacionada à conta que foi analisada para gerar o relatório de despesas recorrentes.

idstring(uuid)

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
institutionobject

Detalhes sobre a instituição.

collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
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"
categorystring or nullobrigatório

O tipo de conta.
Retornamos um dos seguintes valores do enum:

  • CHECKING_ACCOUNT
  • CREDIT_CARD
  • INVESTMENT_ACCOUNT
  • LOAN_ACCOUNT
  • PENSION_FUND_ACCOUNT
  • SAVINGS_ACCOUNT
  • UNCATEGORIZED
  • null
Enum"CHECKING_ACCOUNT""CREDIT_CARD""INVESTMENT_ACCOUNT""LOAN_ACCOUNT""PENSION_FUND_ACCOUNT""SAVINGS_ACCOUNT""UNCATEGORIZED"null
Exemplo: "CHECKING_ACCOUNT"
balance_typestring or nullobrigatório

Indica se esta conta é um ASSET ou um LIABILITY. Você pode considerar o saldo de um ASSET como positivo, enquanto o saldo de um LIABILITY como negativo.

Exemplo: "ASSET"
typestring or nullobrigatório

O tipo de conta, conforme designado pela instituição.

Exemplo: "Cuentas de efectivo"
namestring or nullobrigatório

O nome da conta, conforme fornecido pela instituição.

Exemplo: "Cuenta Perfiles- M.N. - MXN-666"
numberstring or nullobrigatório

O número da conta, conforme designado pela instituição.

Exemplo: "4057068115181"
balanceobjectobrigatório

Detalhes sobre os saldos atual e disponível para a conta.

currentnumber or null(float)obrigatório

O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.

  • 💰 Contas correntes e poupança:

O saldo da conta do usuário no timestamp collected_at.

  • 💳 Cartões de crédito:

O valor que o usuário gastou no período de faturamento atual do cartão (consulte credit_data.cutting_date para informações sobre quando o período de faturamento atual termina).

  • 🏡 Contas de empréstimo:

O valor restante a pagar no empréstimo do usuário.

Exemplo: 5874.13
availablenumber or null(float)

O saldo que o proprietário da conta pode usar.

  • 💰 Contas correntes e poupança:

O saldo disponível pode ser diferente do saldo current devido a transações pendentes.

  • 💳 Cartões de crédito:

O valor de crédito que o usuário ainda tem disponível para o período atual. O saldo available pode ser diferente do saldo current devido a transações pendentes ou parcelas futuras.

  • 🏡 Contas de empréstimo:

O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição.

Nota: Se a instituição não fornecer este valor, retornamos null.

Exemplo: 5621.12
currencystring or nullobrigatório

A moeda da conta. Por exemplo:

  • 🇧🇷 BRL (Real Brasileiro)
  • 🇨🇴 COP (Peso Colombiano)
  • 🇲🇽 MXN (Peso Mexicano)

Por favor, note que outras moedas além das listadas acima podem ser retornadas.

Exemplo: "MXN"
public_identification_namestring or nullobrigatório

O nome público para o tipo de identificação. Por exemplo: "CLABE".

ℹ️ Para contas de poupança e corrente 🇧🇷 brasileiras, este campo será AGENCY/ACCOUNT.

Exemplo: "CLABE"
public_identification_valuestring or nullobrigatório

O valor para o public_identification_name.

ℹ️ Para contas de poupança e corrente brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: 0444/45722-0.

Exemplo: "150194683119900273"
last_accessed_atstring or null(date-time)obrigatório

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"
credit_dataobject or nullobrigatório

As opções de crédito associadas a esta conta.

credit_limitnumber or null(float)obrigatório

O valor máximo de crédito que o proprietário pode receber.

Exemplo: 192000
collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
cutting_datestring or nullobrigatório

A data de encerramento do período de crédito, no formato YYYY-MM-DD.

Exemplo: "2019-12-11"
next_payment_datestringobrigatório

A data de vencimento para o próximo pagamento, no formato YYYY-MM-DD.

Exemplo: "2019-12-13"
minimum_paymentnumber or null(float)obrigatório

O valor mínimo a ser pago na next_payment_date.

Exemplo: 2400.3
no_interest_paymentnumber or null(float)obrigatório

O valor mínimo necessário para pagar para evitar a geração de juros.

Exemplo: 2690.83
interest_ratenumber or null(float)obrigatório

A taxa de juros anualizada do crédito.

Exemplo: 4
monthly_paymentnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O pagamento mensal recorrente, se aplicável.

Exemplo: null
last_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data em que o último pagamento de crédito foi realizado, no formato YYYY-MM-DD.

Exemplo: null
last_period_balancestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O saldo restante após o last_payment_date.

Exemplo: null
loan_dataobject or nullobrigatório

As opções de empréstimo associadas a esta conta.

collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
contract_amountnumber or null(float)

O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas.

Exemplo: 202000
principalnumber or null(float)obrigatório

Valor total do empréstimo (o valor que o usuário recebe).

Exemplo: 192000
loan_typestring or null

O tipo do empréstimo, de acordo com a instituição.

Exemplo: "Consignado"
payment_daystring or null

O dia do mês em que o proprietário precisa pagar o empréstimo (DD).

Exemplo: "27"
outstanding_principalnumber or null(float)

Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros).

Exemplo: 142023
outstanding_balancenumber or null(float)obrigatório

O valor restante a pagar no total, incluindo juros.

Exemplo: 182000
monthly_paymentnumber or null(float)obrigatório

O pagamento mensal recorrente, se aplicável.

Exemplo: 1000
interest_ratesArray of objects or nullobrigatório

Detalhamento dos juros aplicados ao empréstimo.

namestring or nullobrigatório

O nome do tipo de taxa de juros aplicada ao empréstimo.

Exemplo: "jurosEfetivo"
typestring or nullobrigatório

O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores:

  • MONTHLY
  • YEARLY
Enum"MONTHLY""YEARLY"
Exemplo: "MONTHLY"
valuenumber or null(float)obrigatório

A taxa de juros (em porcentagem ou valor monetário).

Exemplo: 7.85
feesArray of objects or null or null

Detalhamento das taxas aplicadas ao empréstimo.

number_of_installments_totalinteger or null(int32)

O número total de parcelas necessárias para pagar o empréstimo.

Exemplo: 60
number_of_installments_outstandinginteger or null(int32)

O número de parcelas restantes para pagar.

Exemplo: 48
contract_start_datestring or null

A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.

Exemplo: "2020-03-01"
contract_end_datestring(date)

A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.

Exemplo: "2027-10-01"
contract_numberstring or null

O número do contrato do empréstimo, conforme fornecido pela instituição.

Exemplo: "890ASLDJF87SD00"
credit_limitnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte principal em vez disso.

Exemplo: null
last_period_balancenumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte outstanding_balance em vez disso.

Exemplo: null
interest_ratenumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, consulte o objeto interest_rates.

Exemplo: null
limit_daystring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Consulte payment_day em vez disso.

Exemplo: null
cutting_daystring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre campos descontinuados.

O dia de fechamento do mês para o empréstimo.

Exemplo: null
cutting_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data de encerramento do período do empréstimo, no formato YYYY-MM-DD.

Exemplo: null
last_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

A data em que o último pagamento do empréstimo foi realizado, no formato YYYY-MM-DD.

next_payment_datestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Por favor, use payment_day em vez disso, no formato YYYY-MM-DD.

Exemplo: null
no_interest_paymentnumber or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O valor mínimo necessário para pagar e evitar a geração de juros.

Exemplo: null
funds_dataArray of objects or null

Um ou mais fundos que contribuem para a conta de pensão.

bank_product_idstring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuações, consulte nossa explicação sobre Campos descontinuados.

O ID de produto da instituição para o tipo de conta.

Exemplo: null
internal_identificationstring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

Identificação interna da instituição para a conta.

Exemplo: null
namestring or nullobrigatório

O nome para a despesa recorrente.

ℹ️ Nota: Esta informação é retirada da seção de descrição de uma transação e, em seguida, normalizada para fornecer um nome de fácil leitura. Assim, às vezes o nome refletirá o comerciante para o qual o pagamento é feito (por exemplo, Netflix.com), enquanto para outras despesas recorrentes, isso pode ser algo como "Pagamento mensal para John".

Padrão null
Exemplo: "Netflix"
transactionsArray of objects or nullobrigatório

Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio.

amountnumber(float)obrigatório

O valor da transação.

Exemplo: 2145.45
descriptionstring or nullobrigatório

A descrição da transação fornecida pela instituição. Normalmente, este é o texto que o usuário final veria no extrato bancário. A descrição pode ser uma string vazia.

Nota: Para o EYOD Risk Insights, a descrição é aquela que você forneceu na solicitação inicial.

Exemplo: "Netflix.com/march"
value_datestring(date)obrigatório

A data em que a transação ocorreu, no formato YYYY-MM-DD.

Exemplo: "2019-10-23"
frequencystringobrigatório

A frequência com que essa despesa recorrente ocorre.

ℹ️ Nota: A Belvo identifica apenas frequências MONTHLY.

Padrão "MONTHLY"
Valor"MONTHLY"
Exemplo: "MONTHLY"
average_transaction_amountnumber(float)obrigatório

O valor médio da transação da despesa recorrente.

Exemplo: 32.9
median_transaction_amountnumber(float)obrigatório

O valor mediano da transação da despesa recorrente.

Exemplo: 32.9
days_since_last_transactioninteger(int32)obrigatório

Número de dias desde que a última despesa recorrente ocorreu.

Com base na frequência, você pode inferir quantos dias faltam até que a próxima cobrança ocorra.

Exemplo: 5
categorystringobrigatório

A categoria de transação para a despesa recorrente. Para mais informações sobre as categorias disponíveis, consulte nossa documentação de categorização de transações.

  • Online Platforms & Leisure (Netflix, Spotify, Assinaturas de Academia)
  • Bills & Utilities (eletricidade, telefone, internet)
  • Credits & Loans (adiantamentos de cartão de crédito, empréstimo estudantil, leasing de embarcações)
  • Insurance (seguro residencial, automotivo, e de saúde & vida)
  • Transport & Travel (viagem de Uber, airbnb, estacionamento)
  • Taxes (taxa de serviço, doação, impostos judiciais)
Enum"Bills & Utilities""Credits & Loans""Insurance""Online Platforms & Leisure""Transport & Travel""Taxes"
Exemplo: "Online Platforms & Leisure"
payment_typestring or nullobrigatório

O tipo de despesa recorrente. Retornamos um dos seguintes valores:

  • SUBSCRIPTION
  • REGULAR
Enum"SUBSCRIPTION""REGULAR"
Exemplo: "SUBSCRIPTION"
]
Resposta
application/json
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "account": {}, "name": "Netflix", "transactions": [], "frequency": "MONTHLY", "average_transaction_amount": 32.9, "median_transaction_amount": 32.9, "days_since_last_transaction": 5, "category": "Online Platforms & Leisure", "payment_type": "SUBSCRIPTION" } ]

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 customer é o pagador que vai transferir fundos para sua conta bancária. Você precisa criar um customer para receber pagamentos de entrada na conta bancária da sua organização.

Operações

Bank Accounts (Brazil)

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.

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

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