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.
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/risk-insights/{id}/
https://sandbox.belvo.com/api/risk-insights/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/risk-insights/{id}/?fields=string&omit=string'Ok
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
Um array de números de conta gerados pela Belvo (UUIDs) que foram usados durante a análise de insights de risco. Se nenhuma conta for encontrada, retornamos um array vazio.
Agregue detalhes sobre os ativos utilizados na análise de percepção de risco. Para métricas de ativos, consideramos apenas contas correntes e contas de poupança.
As métricas de ativos podem fornecer uma visão geral da riqueza e dos ativos líquidos do seu usuário, indicando como eles gerenciam sua riqueza e seu status financeiro atual.
Um array de instituições das quais as informações da conta foram recuperadas para o usuário.
Nota: Para a maioria dos casos de uso, este array retornará apenas um item.
O número total de contas encontradas para o usuário.
O número total de contas correntes encontradas para o usuário.
O número total de contas poupança encontradas para o usuário.
O saldo total de fechamento de todas as contas correntes.
Métricas agregadas calculadas com base nas contas de cartão de crédito do usuário.
As métricas de cartão de crédito ilustram os hábitos de um cliente em relação aos cartões de crédito, revelando quantas contas de cartão de crédito um cliente possui, seu limite de crédito total, quanto desse limite está sendo utilizado e a taxa de utilização do limite do cartão de crédito.
Número de contas de cartões de crédito associadas ao usuário.
Soma total de todos os limites dos cartões de crédito.
Soma total de todo o crédito utilizado.
Métricas agregadas calculadas com base nas contas de empréstimo do usuário e contas correntes que possuem cheque especial.
As métricas de empréstimo ajudam a entender o comportamento de empréstimo e reembolso de um cliente, o que pode ajudar a avaliar sua capacidade de assumir crédito adicional e os potenciais riscos de inadimplência.
O número de contas de empréstimo associadas ao usuário.
Soma total do principal para todas as contas de empréstimo do usuário.
Soma total do principal pendente para todas as contas de empréstimo do usuário.
Soma total dos pagamentos mensais de todas as contas de empréstimo do usuário.
A porcentagem do limite do empréstimo utilizado.
O limite total de cheque especial de todas as contas correntes e de poupança.
Métricas de saldo calculadas com base nos saldos do usuário em contas correntes e de poupança.
O saldo de todas as contas no momento collected_at.
O saldo mínimo nos últimos três dias.
O saldo mínimo nos últimos três meses.
O saldo mínimo nos últimos seis meses.
O saldo mínimo nos últimos doze meses.
O saldo médio nos últimos três dias.
O saldo médio nos últimos três meses.
O saldo médio nos últimos seis meses.
O saldo médio nos últimos doze meses.
O saldo máximo nos últimos três dias.
O saldo máximo nos últimos três meses.
O saldo máximo nos últimos seis meses.
O saldo máximo nos últimos doze meses.
O desvio padrão do saldo nos últimos três dias.
O desvio padrão do saldo na última semana.
O desvio padrão do saldo no último mês.
O desvio padrão do saldo nos últimos três meses.
O desvio padrão do saldo nos últimos seis meses.
O desvio padrão do saldo nos últimos doze meses.
A tendência de saldo do usuário nos últimos três dias.
A tendência de saldo do usuário na última semana.
A tendência de saldo do usuário no último mês.
A tendência de saldo do usuário nos últimos três meses.
A tendência de saldo do usuário nos últimos seis meses.
A tendência de saldo do usuário nos últimos doze meses.
O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três dias.
O número de dias em que o saldo total da conta é menor ou igual a 0 na última semana.
O número de dias em que o saldo total da conta é menor ou igual a 0 no último mês.
O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três meses.
O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos seis meses.
O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos doze meses.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3d.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1w.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1m.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3m.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_6m.
O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_12m.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x nos últimos três dias.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x na última semana.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x no último mês.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x nos últimos três meses.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x nos últimos seis meses.
O número de dias em que o saldo total da conta é menor ou igual ao valor especificado em balance_threshold_x nos últimos doze meses.
Métricas agregadas calculadas com base nas transações do usuário em contas correntes, poupança, cartão de crédito e empréstimo.
ℹ️ Nota
Se não houver dados transacionais suficientes para um determinado período, retornamos
nullpara campos calculados e0para campos baseados em contagem. Por exemplo, se a conta foi aberta há apenas cinco dias (ou se você forneceu dados apenas para cinco dias), retornamos valores para_3d,_1we_1m, no entanto:
mean_num_transactions_3mretornaránull, pois não há dados para os meses dois e três (campo calculado).num_transactions_3mretornará0, pois não há dados para os meses dois e três (campo baseado em contagem).
O número total de transações analisadas para determinar as percepções de risco nos últimos três dias (entradas e saídas).
O número total de transações analisadas para determinar as percepções de risco da última semana (entradas e saídas).
O número total de transações analisadas para determinar as percepções de risco do último mês (entradas e saídas).
O número total de transações analisadas para determinar as percepções de risco nos últimos três meses (entradas e saídas).
O número total de transações analisadas para determinar as percepções de risco nos últimos seis meses (entradas e saídas).
O número total de transações analisadas para determinar as percepções de risco nos últimos doze meses (entradas e saídas).
O número máximo de transações nos últimos três dias.
O número máximo de transações da última semana.
O número máximo de transações do último mês.
O número máximo de transações nos últimos três meses.
O número máximo de transações nos últimos seis meses.
O número máximo de transações nos últimos doze meses.
O número médio de transações nos últimos três dias.
O número médio de transações da última semana.
O número médio de transações do último mês.
O número médio de transações nos últimos três meses.
O número médio de transações nos últimos seis meses.
O número médio de transações nos últimos doze meses.
O número total de transações de entrada nos últimos três dias.
O número total de transações de entrada na última semana.
O número total de transações de entrada do último mês.
O número total de transações de entrada nos últimos três meses.
O número total de transações de entrada nos últimos seis meses.
O número total de transações de entrada nos últimos doze meses.
O número máximo de transações de entrada nos últimos três dias.
O número máximo de transações de entrada na última semana.
O número máximo de transações de entrada no último mês.
O número máximo de transações de entrada nos últimos três meses.
O número máximo de transações de entrada nos últimos seis meses.
O número máximo de transações de entrada nos últimos doze meses.
O número médio de transações de entrada nos últimos três dias.
O número médio de transações de entrada na última semana.
O número médio de transações de entrada no último mês.
O número médio de transações de entrada nos últimos três meses.
O número médio de transações de entrada nos últimos seis meses.
O número médio de transações de entrada nos últimos doze meses.
A soma total de todas as transações de entrada dos últimos três dias.
A soma total de todas as transações de entrada da última semana.
A soma total de todas as transações de entrada do último mês.
A soma total de todas as transações de entrada dos últimos três meses.
A soma total de todas as transações de entrada dos últimos seis meses.
A soma total de todas as transações de entrada dos últimos doze meses.
A transação de entrada de maior valor nos últimos três dias.
A transação de entrada de maior valor na última semana.
A transação de entrada de maior valor no último mês.
A transação de entrada de maior valor nos últimos três meses.
A transação de entrada de maior valor nos últimos seis meses.
A transação de entrada de maior valor nos últimos doze meses.
O valor médio de entrada de todas as transações nos últimos três dias.
O valor médio de entrada de todas as transações na última semana.
O valor médio de entrada de todas as transações no último mês.
O valor médio de entrada de todas as transações nos últimos três meses.
O valor médio de entrada de todas as transações nos últimos seis meses.
O valor médio de entrada de todas as transações nos últimos doze meses.
Para o número total de transações de saída nos últimos três dias.
Para o número total de transações de saída na última semana.
Total de transações de saída no último mês.
Total de transações de saída nos últimos três meses.
Para o número total de transações de saída nos últimos seis meses.
Total de transações de saída nos últimos doze meses.
O número máximo de transações de saída nos últimos três dias.
O número máximo de transações de saída na última semana.
O número máximo de transações de saída no último mês.
O número máximo de transações de saída nos últimos três meses.
O número máximo de transações de saída nos últimos seis meses.
O número máximo de transações de saída nos últimos doze meses.
O número médio de transações de saída nos últimos três dias.
O número médio de transações de saída na última semana.
O número médio de transações de saída no último mês.
O número médio de transações de saída nos últimos três meses.
O número médio de transações de saída nos últimos seis meses.
O número médio de transações de saída nos últimos doze meses.
A soma total de todas as transações de saída dos últimos três dias.
A soma total de todas as transações de saída da última semana.
A soma total de todas as transações de saída do último mês.
A soma total de todas as transações de saída dos últimos três meses.
A soma total de todas as transações de saída dos últimos seis meses.
A soma total de todas as transações de saída dos últimos doze meses.
A transação de saída de maior valor nos últimos três dias.
A transação de saída de maior valor na última semana.
A transação de saída de maior valor no último mês.
A transação de saída de maior valor nos últimos três meses.
A transação de saída de maior valor nos últimos seis meses.
A transação de saída de maior valor nos últimos doze meses.
O valor médio de saída de todas as transações nos últimos três dias.
O valor médio de saída de todas as transações na última semana.
O valor médio de saída de todas as transações no último mês.
O valor médio de saída de todas as transações nos últimos três meses.
O valor médio de saída de todas as transações nos últimos seis meses.
O valor médio de saída de todas as transações nos últimos doze meses.
O número de dias em que nenhuma transação ocorreu nos últimos três dias.
O número de dias em que não ocorreram transações na última semana.
O número de dias em que não ocorreram transações no último mês.
O número de dias em que não ocorreram transações nos últimos três meses.
O número de dias em que não ocorreram transações nos últimos seis meses.
O número de dias em que não ocorreram transações nos últimos doze meses.
O número de dias desde que a última transação ocorreu.
O número de dias desde que a última transação de entrada ocorreu.
O número de dias desde que a última transação de saída ocorreu.
Métricas agregadas calculadas com base nas transações do usuário em contas correntes, poupança, de crédito e de empréstimo. No entanto, transferências internas (transferências entre contas pertencentes ao mesmo link) não são usadas no cálculo.
Se não houver dados transacionais suficientes para um determinado período, retornamos null. Por exemplo, se a conta foi aberta há apenas 15 dias (ou você forneceu dados apenas para 15 dias), retornamos valores para _3d, _1w e _1m, no entanto, para _3m retornaremos null, pois não há dados para os meses dois e três.
O maior valor de transações de fluxo de caixa positivo nos últimos três dias.
O maior valor de transações de fluxo de caixa positivo na semana passada.
O maior valor de transações de fluxo de caixa positivo no mês passado.
O maior valor de transações de fluxo de caixa positivo nos últimos três meses.
O maior valor de transações de fluxo de caixa positivo nos últimos seis meses.
O maior valor de transações de fluxo de caixa positivo nos últimos doze meses.
O maior valor de transações de fluxo de caixa negativo nos últimos três dias.
O maior valor de transações de fluxo de caixa negativo na última semana.
O maior valor de transações de fluxo de caixa negativo no último mês.
O maior valor de transações de fluxo de caixa negativo nos últimos três meses.
O maior valor de transações de fluxo de caixa negativo nos últimos seis meses.
O maior valor de transações de fluxo de caixa negativo nos últimos doze meses.
O valor médio das transações de fluxo de caixa positivo nos últimos três dias.
O valor médio das transações de fluxo de caixa positivo na última semana.
O valor médio das transações de fluxo de caixa positivo no último mês.
O valor médio das transações de fluxo de caixa positivo nos últimos três meses.
O valor médio das transações de fluxo de caixa positivo nos últimos seis meses.
O valor médio das transações de fluxo de caixa positivo nos últimos doze meses.
O valor médio das transações de fluxo de caixa negativo nos últimos três dias.
O valor médio das transações de fluxo de caixa negativo na última semana.
O valor médio das transações de fluxo de caixa negativo no último mês.
O valor médio das transações de fluxo de caixa negativo nos últimos três meses.
O valor médio das transações de fluxo de caixa negativo nos últimos seis meses.
O valor médio das transações de fluxo de caixa negativo nos últimos doze meses.
O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três dias.
O total de todas as transações que resultaram em um fluxo de caixa positivo na última semana.
O total de todas as transações que resultaram em um fluxo de caixa positivo no último mês.
O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três meses.
O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos seis meses.
O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos doze meses.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três dias.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas na última semana.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas no último mês.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três meses.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos seis meses.
A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos doze meses.
O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três dias.
O total de todas as transações que resultaram em um fluxo de caixa negativo na última semana.
O total de todas as transações que resultaram em um fluxo de caixa negativo no último mês.
O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três meses.
O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos seis meses.
O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos doze meses.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três dias.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas na última semana.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas no último mês.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três meses.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos seis meses.
A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos doze meses.
A razão entre sum_positive / sum_negative nos últimos três dias.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais entradas do que saídas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
A razão entre sum_positive / sum_negative na última semana.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais entradas do que saídas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
A razão entre sum_positive / sum_negative no último mês.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais receitas do que despesas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
A razão entre sum_positive / sum_negative nos últimos três meses.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais entradas do que saídas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
A razão entre sum_positive / sum_negative nos últimos seis meses.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais entradas do que saídas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
A razão entre sum_positive / sum_negative nos últimos doze meses.
ℹ️ Se a razão for maior que 1, isso significa que o usuário tem mais receitas do que despesas, indicando que ele gasta menos do que ganha.
Nota: No caso de não haver transações de saída, o valor será null.
O fluxo de caixa líquido nos últimos três dias.
O fluxo de caixa líquido na última semana.
O fluxo de caixa líquido no último mês.
O fluxo de caixa líquido nos últimos três meses.
O fluxo de caixa líquido nos últimos seis meses.
O fluxo de caixa líquido nos últimos doze meses.
A tendência do fluxo de caixa líquido nos últimos três dias meses.
A tendência do fluxo de caixa líquido na última semana.
A tendência do fluxo de caixa líquido no último mês.
A tendência do fluxo de caixa líquido nos últimos três meses.
A tendência do fluxo de caixa líquido nos últimos seis meses.
Um array de métricas agregadas referentes às categorias e subcategorias de transações que a Belvo identificou no histórico de transações do usuário.
No array, a Belvo retorna apenas as categorias que foram identificadas.
O nome da categoria de transação.
Obter categorização de transações Com a categorização de transações, limpamos e categorizamos transações para você, transformando dados brutos em insights acionáveis. Para habilitar esse recurso, basta entrar em contato conosco, e nós cuidaremos disso.
Retornamos um dos seguintes valores de enum:
Bills & UtilitiesCredits & LoansDepositsFees & ChargesFood & GroceriesHome & LifeIncome & PaymentsInsuranceInvestments & SavingsOnline Platforms & LeisurePersonal ShoppingTaxesTransfersTransport & TravelUnknown*Withdrawal & ATMnull* Para clientes que não utilizam nosso produto de Categorização de Transações, retornamos null em vez disso.
A subcategoria da transação.
Obter categorização de transações
Para clientes que não utilizam nossa Categorização de Transações, retornamosnullem vez disso. Para habilitar este recurso, basta entrar em contato conosco, e nós cuidaremos disso.
Retornamos um dos seguintes valores de enum:
Electricity & EnergyRentTelecommunicationsWaterAutoCredit CardInstalmentInterest & ChargesMortgagePay AdvancePersonalAdjustmentsBank FeesChargebackRefundBlocked BalancesAlimonyAlcohol & TobaccoBakery & CoffeeBars & NightclubsConvenience StoreDeliveryGroceriesRestaurantsEducationGyms & FitnessHair & BeautyHealthHome Decor & AppliancesLaundry & Dry CleaningPharmaciesProfessional ServicesVeterinary ServicesFreelanceInterestRetirementSalaryGovernmentHome InsuranceAuto InsuranceHealth & Life InsuranceSavingsFixed incomeEquityInvestment FundsDerivativesCryptocurrenciesApps, Software and Cloud ServicesEvents, Parks and MuseumsGamblingGamingLotteryMovie & AudioBooks & NewsClothing & AccessoriesDepartment StoreElectronicsE-commerceGiftsOffice SuppliesPet SuppliesAuto Tax & FeesDonationGovernment FeesIncome TaxReal Estate Tax & FeesTax ReturnAccommodationAuto ExpensesAuto RentalFlightsGasMileage ProgramsParking & TollsPublic TransitTaxis & RidesharesOthernullO valor líquido das transações para esta categoria nos últimos três meses (calculado como o total de transações de entrada - total de transações de saída para esta categoria).
A razão de net_amount_3m dividida pela soma de todas as transações categorizadas de entrada (incluindo a categoria atual) para o mesmo período.
Nota: Se não houver transações de entrada para o período, este valor retornará null.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "accounts": [ … ], "assets_metrics": { … }, "credit_cards_metrics": { … }, "loans_metrics": { … }, "balances_metrics": { … }, "transactions_metrics": { … }, "cashflow_metrics": { … }, "category_metrics": [ … ] } ]
https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/risk-insights/{id}/
https://sandbox.belvo.com/api/risk-insights/{id}/
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/risk-insights/{id}/'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.