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:
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.
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.
O link.id para o qual você deseja recuperar informações.
O token MFA gerado pela instituição, que é necessário para continuar uma sessão.
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.
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/recurring-expenses/
https://sandbox.belvo.com/api/recurring-expenses/
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"
}'Ok (quando save_data=false)
Identificador único da Belvo para o item atual.
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.
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.
O tipo de conta.
Retornamos um dos seguintes valores do enum:
CHECKING_ACCOUNTCREDIT_CARDINVESTMENT_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDnullIndica 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.
O tipo de conta, conforme designado pela instituição.
O nome da conta, conforme fornecido pela instituição.
O número da conta, conforme designado pela instituição.
Detalhes sobre os saldos atual e disponível para a conta.
O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.
O saldo da conta do usuário no timestamp collected_at.
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).
O valor restante a pagar no empréstimo do usuário.
O saldo que o proprietário da conta pode usar.
O saldo disponível pode ser diferente do saldo current devido a transações pendentes.
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.
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.
A moeda da conta. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
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.
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.
O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
As opções de crédito associadas a esta conta.
O valor máximo de crédito que o proprietário pode receber.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de encerramento do período de crédito, no formato YYYY-MM-DD.
A data de vencimento para o próximo pagamento, no formato YYYY-MM-DD.
O valor mínimo a ser pago na next_payment_date.
O valor mínimo necessário para pagar para evitar a geração de juros.
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.
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.
As opções de empréstimo associadas a esta conta.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas.
Valor total do empréstimo (o valor que o usuário recebe).
O dia do mês em que o proprietário precisa pagar o empréstimo (DD).
Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros).
O valor restante a pagar no total, incluindo juros.
O pagamento mensal recorrente, se aplicável.
Detalhamento dos juros aplicados ao empréstimo.
O nome do tipo de taxa de juros aplicada ao empréstimo.
O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores:
MONTHLYYEARLYO número total de parcelas necessárias para pagar o empréstimo.
O número de parcelas restantes para pagar.
A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.
A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.
O número do contrato do empréstimo, conforme fornecido pela instituição.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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".
Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio.
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.
A frequência com que essa despesa recorrente ocorre.
ℹ️ Nota: A Belvo identifica apenas frequências MONTHLY.
O valor médio da transação da despesa recorrente.
O valor mediano da transação da despesa recorrente.
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.
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)O tipo de despesa recorrente. Retornamos um dos seguintes valores:
SUBSCRIPTIONREGULAR[ { "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" } ]
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.
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.
O token MFA gerado pela instituição, que é necessário para continuar uma sessão.
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.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/recurring-expenses/
https://sandbox.belvo.com/api/recurring-expenses/
curl -i -X PATCH \
-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 '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (quando save_data=false)
Identificador único da Belvo para o item atual.
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.
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.
O tipo de conta.
Retornamos um dos seguintes valores do enum:
CHECKING_ACCOUNTCREDIT_CARDINVESTMENT_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDnullIndica 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.
O tipo de conta, conforme designado pela instituição.
O nome da conta, conforme fornecido pela instituição.
O número da conta, conforme designado pela instituição.
Detalhes sobre os saldos atual e disponível para a conta.
O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.
O saldo da conta do usuário no timestamp collected_at.
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).
O valor restante a pagar no empréstimo do usuário.
O saldo que o proprietário da conta pode usar.
O saldo disponível pode ser diferente do saldo current devido a transações pendentes.
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.
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.
A moeda da conta. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
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.
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.
O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
As opções de crédito associadas a esta conta.
O valor máximo de crédito que o proprietário pode receber.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de encerramento do período de crédito, no formato YYYY-MM-DD.
A data de vencimento para o próximo pagamento, no formato YYYY-MM-DD.
O valor mínimo a ser pago na next_payment_date.
O valor mínimo necessário para pagar para evitar a geração de juros.
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.
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.
As opções de empréstimo associadas a esta conta.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas.
Valor total do empréstimo (o valor que o usuário recebe).
O dia do mês em que o proprietário precisa pagar o empréstimo (DD).
Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros).
O valor restante a pagar no total, incluindo juros.
O pagamento mensal recorrente, se aplicável.
Detalhamento dos juros aplicados ao empréstimo.
O nome do tipo de taxa de juros aplicada ao empréstimo.
O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores:
MONTHLYYEARLYO número total de parcelas necessárias para pagar o empréstimo.
O número de parcelas restantes para pagar.
A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.
A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.
O número do contrato do empréstimo, conforme fornecido pela instituição.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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".
Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio.
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.
A frequência com que essa despesa recorrente ocorre.
ℹ️ Nota: A Belvo identifica apenas frequências MONTHLY.
O valor médio da transação da despesa recorrente.
O valor mediano da transação da despesa recorrente.
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.
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)O tipo de despesa recorrente. Retornamos um dos seguintes valores:
SUBSCRIPTIONREGULAR[ { "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" } ]
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/recurring-expenses/{id}/
https://sandbox.belvo.com/api/recurring-expenses/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/recurring-expenses/{id}/?fields=string&omit=string'Ok
Identificador único da Belvo para o item atual.
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.
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.
O tipo de conta.
Retornamos um dos seguintes valores do enum:
CHECKING_ACCOUNTCREDIT_CARDINVESTMENT_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDnullIndica 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.
O tipo de conta, conforme designado pela instituição.
O nome da conta, conforme fornecido pela instituição.
O número da conta, conforme designado pela instituição.
Detalhes sobre os saldos atual e disponível para a conta.
O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.
O saldo da conta do usuário no timestamp collected_at.
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).
O valor restante a pagar no empréstimo do usuário.
O saldo que o proprietário da conta pode usar.
O saldo disponível pode ser diferente do saldo current devido a transações pendentes.
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.
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.
A moeda da conta. Por exemplo:
Por favor, note que outras moedas além das listadas acima podem ser retornadas.
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.
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.
O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
As opções de crédito associadas a esta conta.
O valor máximo de crédito que o proprietário pode receber.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
A data de encerramento do período de crédito, no formato YYYY-MM-DD.
A data de vencimento para o próximo pagamento, no formato YYYY-MM-DD.
O valor mínimo a ser pago na next_payment_date.
O valor mínimo necessário para pagar para evitar a geração de juros.
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.
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.
As opções de empréstimo associadas a esta conta.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas.
Valor total do empréstimo (o valor que o usuário recebe).
O dia do mês em que o proprietário precisa pagar o empréstimo (DD).
Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros).
O valor restante a pagar no total, incluindo juros.
O pagamento mensal recorrente, se aplicável.
Detalhamento dos juros aplicados ao empréstimo.
O nome do tipo de taxa de juros aplicada ao empréstimo.
O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores:
MONTHLYYEARLYO número total de parcelas necessárias para pagar o empréstimo.
O número de parcelas restantes para pagar.
A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.
A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.
O número do contrato do empréstimo, conforme fornecido pela instituição.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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".
Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio.
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.
A frequência com que essa despesa recorrente ocorre.
ℹ️ Nota: A Belvo identifica apenas frequências MONTHLY.
O valor médio da transação da despesa recorrente.
O valor mediano da transação da despesa recorrente.
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.
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)O tipo de despesa recorrente. Retornamos um dos seguintes valores:
SUBSCRIPTIONREGULAR[ { "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" } ]
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.