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

Risk Insights

Operações

Objeto de Insights de Risco

idstring(uuid)obrigatório

Identificador único da Belvo para o item atual.

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

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
created_atstring(date-time)obrigatório

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"
accountsArray of strings or null(uuid)obrigatório

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.

Exemplo: ["0d3ffb69-f83b-456e-ad8e-208d0998d71d","00293c8e-1152-440b-9892-3c071fb88672","cf638fba-ef45-4c10-bc6f-adecc4b2bf4e","3861a5da-ae9b-4f20-a632-a9294489d5ac","1f60315b-236d-498e-be7a-92bc613d329b","a2c8da63-ed51-41e6-891a-4ae7e784463a"]
assets_metricsobject or nullobrigatório

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.

institutionsArray of strings or nullobrigatório

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.

Exemplo: ["erebor_mx_retail"]
num_assets_accountsinteger or null(int32)

O número total de contas encontradas para o usuário.

Exemplo: 1
num_checking_accountsinteger or null(int32)obrigatório

O número total de contas correntes encontradas para o usuário.

Exemplo: 1
num_savings_accountsinteger or null(int32)obrigatório

O número total de contas poupança encontradas para o usuário.

Exemplo: 1
checking_accounts_balancenumber or null(float)obrigatório

O saldo total de fechamento de todas as contas correntes.

Exemplo: 35901.46
savings_accounts_balancenumber or null(float)obrigatório

O saldo total de fechamento de todas as contas poupança.

Exemplo: 300.02
credit_cards_metricsobject or nullobrigatório

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.

num_accountsinteger(int32)>= 0obrigatório

Número de contas de cartões de crédito associadas ao usuário.

Exemplo: 2
sum_credit_limitnumber or null(float)obrigatório

Soma total de todos os limites dos cartões de crédito.

Exemplo: 106560
sum_credit_usednumber or null(float)obrigatório

Soma total de todo o crédito utilizado.

Exemplo: 101020.14
credit_card_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite do cartão de crédito utilizado.

Exemplo: 0.95
loans_metricsobject or nullobrigatório

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.

num_accountsinteger(int32)obrigatório

O número de contas de empréstimo associadas ao usuário.

Exemplo: 1
sum_loans_principalnumber or null(float)obrigatório

Soma total do principal para todas as contas de empréstimo do usuário.

Exemplo: 5000
sum_loans_outstanding_principalnumber or null(float)obrigatório

Soma total do principal pendente para todas as contas de empréstimo do usuário.

Exemplo: 2000
sum_loans_monthly_paymentnumber or null(float)obrigatório

Soma total dos pagamentos mensais de todas as contas de empréstimo do usuário.

Exemplo: 400
loan_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite do empréstimo utilizado.

Exemplo: 0.3
overdraft_limitnumber or null(float)obrigatório

O limite total de cheque especial de todas as contas correntes e de poupança.

Exemplo: 900
overdraft_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite de cheque especial utilizado.

Exemplo: 0.4
balances_metricsobject or nullobrigatório

Métricas de saldo calculadas com base nos saldos do usuário em contas correntes e de poupança.

closing_balancenumber or null(float)obrigatório

O saldo de todas as contas no momento collected_at.

Exemplo: 35901.46
min_balance_3dnumber or null(float)obrigatório

O saldo mínimo nos últimos três dias.

Exemplo: 35417.68
min_balance_1wnumber or null(float)obrigatório

O saldo mínimo na última semana).

Exemplo: 34150.5
min_balance_1mnumber or null(float)obrigatório

O saldo mínimo no último mês.

Exemplo: 33990.59
min_balance_3mnumber or null(float)obrigatório

O saldo mínimo nos últimos três meses.

Exemplo: 33990.59
min_balance_6mnumber or null(float)obrigatório

O saldo mínimo nos últimos seis meses.

Exemplo: 33990.59
min_balance_12mnumber or null(float)obrigatório

O saldo mínimo nos últimos doze meses.

Exemplo: 33990.59
mean_balance_3dnumber or null(float)obrigatório

O saldo médio nos últimos três dias.

Exemplo: 35659.57
mean_balance_1wnumber or null(float)obrigatório

O saldo médio na última semana.

Exemplo: 35077.1
mean_balance_1mnumber or null(float)obrigatório

O saldo médio no último mês.

Exemplo: 34816.08
mean_balance_3mnumber or null(float)obrigatório

O saldo médio nos últimos três meses.

Exemplo: 34816.08
mean_balance_6mnumber or null(float)obrigatório

O saldo médio nos últimos seis meses.

Exemplo: 34816.08
mean_balance_12mnumber or null(float)obrigatório

O saldo médio nos últimos doze meses.

Exemplo: 34816.08
max_balance_3dnumber or null(float)obrigatório

O saldo máximo nos últimos três dias.

Exemplo: 35901.46
max_balance_1wnumber or null(float)obrigatório

O saldo máximo na última semana.

Exemplo: 35901.46
max_balance_1mnumber or null(float)obrigatório

O saldo máximo no último mês.

Exemplo: 35901.46
max_balance_3mnumber or null(float)obrigatório

O saldo máximo nos últimos três meses.

Exemplo: 35901.46
max_balance_6mnumber or null(float)obrigatório

O saldo máximo nos últimos seis meses.

Exemplo: 35901.46
max_balance_12mnumber or null(float)obrigatório

O saldo máximo nos últimos doze meses.

Exemplo: 35901.46
std_balance_3dnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos três dias.

Exemplo: 279.31
std_balance_1wnumber or null(float)obrigatório

O desvio padrão do saldo na última semana.

Exemplo: 764.03
std_balance_1mnumber or null(float)obrigatório

O desvio padrão do saldo no último mês.

Exemplo: 586.55
std_balance_3mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos três meses.

Exemplo: 586.55
std_balance_6mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos seis meses.

Exemplo: 586.55
std_balance_12mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos doze meses.

Exemplo: 586.55
balance_trend_3dnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos três dias.

Exemplo: 193.51
balance_trend_1wnumber or null(float)obrigatório

A tendência de saldo do usuário na última semana.

Exemplo: 290.18
balance_trend_1mnumber or null(float)obrigatório

A tendência de saldo do usuário no último mês.

Exemplo: 22.6
balance_trend_3mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos três meses.

Exemplo: 22.6
balance_trend_6mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos seis meses.

Exemplo: 22.6
balance_trend_12mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos doze meses.

Exemplo: 22.6
days_balance_below_0_3dinteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três dias.

Exemplo: 0
days_balance_below_0_1winteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 na última semana.

Exemplo: 0
days_balance_below_0_1minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 no último mês.

Exemplo: 0
days_balance_below_0_3minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três meses.

Exemplo: 0
days_balance_below_0_6minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos seis meses.

Exemplo: 0
days_balance_below_0_12minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos doze meses.

Exemplo: 0
days_balance_below_mean_3dinteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3d.

Exemplo: 2
days_balance_below_mean_1winteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1w.

Exemplo: 3
days_balance_below_mean_1minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1m.

Exemplo: 17
days_balance_below_mean_3minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3m.

Exemplo: 17
days_balance_below_mean_6minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_6m.

Exemplo: 17
days_balance_below_mean_12minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_12m.

Exemplo: 17
days_balance_below_x_3dinteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_1winteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_1minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_3minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_6minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_12minteger or null(int32)obrigatório

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.

Exemplo: 0
balance_threshold_xnumber(float)obrigatório

O limite usado para calcular days_balance_below_x_period. Por favor, note que este valor é específico para cada país (tanto em termos de quantia quanto de moeda).

Exemplo: 1000
transactions_metricsobject or nullobrigatório

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 null para campos calculados e 0 para 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, _1w e _1m, no entanto:

  • mean_num_transactions_3m retornará null, pois não há dados para os meses dois e três (campo calculado).
  • num_transactions_3m retornará 0, pois não há dados para os meses dois e três (campo baseado em contagem).
num_transactions_3dinteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos três dias (entradas e saídas).

Padrão 0
Exemplo: 26
num_transactions_1winteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco da última semana (entradas e saídas).

Padrão 0
Exemplo: 46
num_transactions_1minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco do último mês (entradas e saídas).

Padrão 0
Exemplo: 168
num_transactions_3minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos três meses (entradas e saídas).

Padrão 0
Exemplo: 460
num_transactions_6minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos seis meses (entradas e saídas).

Padrão 670
Exemplo: 472
num_transactions_12minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos doze meses (entradas e saídas).

Padrão 0
Exemplo: 496
max_num_transactions_3dinteger(int32)obrigatório

O número máximo de transações nos últimos três dias.

Padrão 0
Exemplo: 10
max_num_transactions_1winteger(int32)obrigatório

O número máximo de transações da última semana.

Padrão 0
Exemplo: 10
max_num_transactions_1minteger(int32)obrigatório

O número máximo de transações do último mês.

Padrão 0
Exemplo: 18
max_num_transactions_3minteger(int32)obrigatório

O número máximo de transações nos últimos três meses.

Padrão 0
Exemplo: 18
max_num_transactions_6minteger(int32)obrigatório

O número máximo de transações nos últimos seis meses.

Padrão 0
Exemplo: 18
max_num_transactions_12minteger(int32)obrigatório

O número máximo de transações nos últimos doze meses.

Padrão 0
Exemplo: 18
mean_num_transactions_3dnumber(float)obrigatório

O número médio de transações nos últimos três dias.

Padrão 0
Exemplo: 6.5
mean_num_transactions_1wnumber(float)obrigatório

O número médio de transações da última semana.

Padrão 0
Exemplo: 5.75
mean_num_transactions_1mnumber(float)obrigatório

O número médio de transações do último mês.

Padrão 0
Exemplo: 5.42
mean_num_transactions_3mnumber(float)obrigatório

O número médio de transações nos últimos três meses.

Padrão 0
Exemplo: 5.05
mean_num_transactions_6mnumber(float)obrigatório

O número médio de transações nos últimos seis meses.

Padrão 0
Exemplo: 2.61
mean_num_transactions_12mnumber(float)obrigatório

O número médio de transações nos últimos doze meses.

Padrão 0
Exemplo: 1.37
num_incoming_transactions_3dinteger(int32)obrigatório

O número total de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 12
num_incoming_transactions_1winteger(int32)obrigatório

O número total de transações de entrada na última semana.

Padrão 0
Exemplo: 21
num_incoming_transactions_1minteger(int32)obrigatório

O número total de transações de entrada do último mês.

Padrão 0
Exemplo: 80
num_incoming_transactions_3minteger(int32)obrigatório

O número total de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 229
num_incoming_transactions_6minteger(int32)obrigatório

O número total de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 238
num_incoming_transactions_12minteger(int32)obrigatório

O número total de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 256
max_num_incoming_transactions_3dinteger(int32)obrigatório

O número máximo de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 6
max_num_incoming_transactions_1winteger(int32)obrigatório

O número máximo de transações de entrada na última semana.

Padrão 0
Exemplo: 6
max_num_incoming_transactions_1minteger(int32)obrigatório

O número máximo de transações de entrada no último mês.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_3minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_6minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_12minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 10
mean_num_incoming_transactions_3dnumber(float)obrigatório

O número médio de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 3
mean_num_incoming_transactions_1wnumber(float)obrigatório

O número médio de transações de entrada na última semana.

Padrão 0
Exemplo: 2.62
mean_num_incoming_transactions_1mnumber(float)obrigatório

O número médio de transações de entrada no último mês.

Padrão 0
Exemplo: 2.58
mean_num_incoming_transactions_3mnumber(float)obrigatório

O número médio de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 2.52
mean_num_incoming_transactions_6mnumber(float)obrigatório

O número médio de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 1.31
mean_num_incoming_transactions_12mnumber(float)obrigatório

O número médio de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 0.71
sum_incoming_amount_3dnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos três dias.

Exemplo: 17142.16
sum_incoming_amount_1wnumber or null(float)obrigatório

A soma total de todas as transações de entrada da última semana.

Exemplo: 24825.92
sum_incoming_amount_1mnumber or null(float)obrigatório

A soma total de todas as transações de entrada do último mês.

Exemplo: 75993.36
sum_incoming_amount_3mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos três meses.

Exemplo: 198197.28
sum_incoming_amount_6mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos seis meses.

Exemplo: 223697.28
sum_incoming_amount_12mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos doze meses.

Exemplo: 274697.28
max_incoming_amount_3dnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos três dias.

Exemplo: 3000
max_incoming_amount_1wnumber or null(float)obrigatório

A transação de entrada de maior valor na última semana.

Exemplo: 3000
max_incoming_amount_1mnumber or null(float)obrigatório

A transação de entrada de maior valor no último mês.

Exemplo: 3000
max_incoming_amount_3mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos três meses.

Exemplo: 3000
max_incoming_amount_6mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos seis meses.

Exemplo: 3000
max_incoming_amount_12mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos doze meses.

Exemplo: 3000
mean_incoming_amount_3dnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos três dias.

Exemplo: 1428.51
mean_incoming_amount_1wnumber or null(float)obrigatório

O valor médio de entrada de todas as transações na última semana.

Exemplo: 1182.19
mean_incoming_amount_1mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações no último mês.

Exemplo: 949.92
mean_incoming_amount_3mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos três meses.

Exemplo: 865.49
mean_incoming_amount_6mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos seis meses.

Exemplo: 939.9
mean_incoming_amount_12mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos doze meses.

Exemplo: 1073.04
num_outgoing_transactions_3dinteger(int32)obrigatório

Para o número total de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 14
num_outgoing_transactions_1winteger(int32)obrigatório

Para o número total de transações de saída na última semana.

Padrão 0
Exemplo: 25
num_outgoing_transactions_1minteger(int32)obrigatório

Total de transações de saída no último mês.

Padrão 0
Exemplo: 88
num_outgoing_transactions_3minteger(int32)obrigatório

Total de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 231
num_outgoing_transactions_6minteger(int32)obrigatório

Para o número total de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 234
num_outgoing_transactions_12minteger(int32)obrigatório

Total de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 240
max_num_outgoing_transactions_3dinteger(int32)obrigatório

O número máximo de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 6
max_num_outgoing_transactions_1winteger(int32)obrigatório

O número máximo de transações de saída na última semana.

Padrão 0
Exemplo: 6
max_num_outgoing_transactions_1minteger(int32)obrigatório

O número máximo de transações de saída no último mês.

Padrão 0
Exemplo: 8
max_num_outgoing_transactions_3minteger(int32)obrigatório

O número máximo de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 9
max_num_outgoing_transactions_6minteger(int32)obrigatório

O número máximo de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 9
max_num_outgoing_transactions_12minteger(int32)obrigatório

O número máximo de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 9
mean_num_outgoing_transactions_3dnumber(float)obrigatório

O número médio de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 3.5
mean_num_outgoing_transactions_1wnumber(float)obrigatório

O número médio de transações de saída na última semana.

Padrão 0
Exemplo: 3.12
mean_num_outgoing_transactions_1mnumber(float)obrigatório

O número médio de transações de saída no último mês.

Padrão 0
Exemplo: 2.84
mean_num_outgoing_transactions_3mnumber(float)obrigatório

O número médio de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 2.54
mean_num_outgoing_transactions_6mnumber(float)obrigatório

O número médio de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 1.29
mean_num_outgoing_transactions_12mnumber(float)obrigatório

O número médio de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 0.66
sum_outgoing_amount_3dnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos três dias.

Exemplo: 18246.95
sum_outgoing_amount_1wnumber or null(float)obrigatório

A soma total de todas as transações de saída da última semana.

Exemplo: 26362.25
sum_outgoing_amount_1mnumber or null(float)obrigatório

A soma total de todas as transações de saída do último mês.

Exemplo: 78243.82
sum_outgoing_amount_3mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos três meses.

Exemplo: 192608.77
sum_outgoing_amount_6mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos seis meses.

Exemplo: 201608.77
sum_outgoing_amount_12mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos doze meses.

Exemplo: 219608.77
max_outgoing_amount_3dnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos três dias.

Exemplo: 3000
max_outgoing_amount_1wnumber or null(float)obrigatório

A transação de saída de maior valor na última semana.

Exemplo: 3000
max_outgoing_amount_1mnumber or null(float)obrigatório

A transação de saída de maior valor no último mês.

Exemplo: 3000
max_outgoing_amount_3mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos três meses.

Exemplo: 3000
max_outgoing_amount_6mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos seis meses.

Exemplo: 3000
max_outgoing_amount_12mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos doze meses.

Exemplo: 3000
mean_outgoing_amount_3dnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos três dias.

Exemplo: 1303.35
mean_outgoing_amount_1wnumber or null(float)obrigatório

O valor médio de saída de todas as transações na última semana.

Exemplo: 1054.49
mean_outgoing_amount_1mnumber or null(float)obrigatório

O valor médio de saída de todas as transações no último mês.

Exemplo: 889.13
mean_outgoing_amount_3mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos três meses.

Exemplo: 833.8
mean_outgoing_amount_6mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos seis meses.

Exemplo: 861.58
mean_outgoing_amount_12mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos doze meses.

Exemplo: 915.04
days_without_transactions_3dinteger(int32)obrigatório

O número de dias em que nenhuma transação ocorreu nos últimos três dias.

Padrão 0
Exemplo: 0
days_without_transactions_1winteger(int32)obrigatório

O número de dias em que não ocorreram transações na última semana.

Padrão 0
Exemplo: 0
days_without_transactions_1minteger(int32)obrigatório

O número de dias em que não ocorreram transações no último mês.

Padrão 0
Exemplo: 0
days_without_transactions_3minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos três meses.

Padrão 0
Exemplo: 0
days_without_transactions_6minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos seis meses.

Padrão 0
Exemplo: 87
days_without_transactions_12minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos doze meses.

Padrão 0
Exemplo: 261
days_since_last_transactioninteger(int32)obrigatório

O número de dias desde que a última transação ocorreu.

Padrão 0
Exemplo: 0
days_since_last_incoming_transactioninteger(int32)obrigatório

O número de dias desde que a última transação de entrada ocorreu.

Padrão 0
Exemplo: 0
days_since_last_outgoing_transactioninteger(int32)obrigatório

O número de dias desde que a última transação de saída ocorreu.

Padrão 0
Exemplo: 0
days_historyinteger(int32)obrigatório

O número de dias entre a solicitação de insight de risco e a primeira transação.

Padrão 0
Exemplo: 365
cashflow_metricsobject or nullobrigatório

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.

max_positive_3dnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos três dias.

Exemplo: 1850.12
max_positive_1wnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo na semana passada.

Exemplo: 3808.99
max_positive_1mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo no mês passado.

Exemplo: 4012.61
max_positive_3mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos três meses.

Exemplo: 5001.08
max_positive_6mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos seis meses.

Exemplo: 8500
max_positive_12mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos doze meses.

Exemplo: 8500
max_negative_3dnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos três dias.

Exemplo: 3375.43
max_negative_1wnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo na última semana.

Exemplo: 3375.43
max_negative_1mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo no último mês.

Exemplo: 5305.92
max_negative_3mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos três meses.

Exemplo: 7535.85
max_negative_6mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos seis meses.

Exemplo: 7535.85
max_negative_12mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos doze meses.

Exemplo: 7535.85
mean_positive_3dnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos três dias.

Exemplo: 1410.54
mean_positive_1wnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo na última semana.

Exemplo: 1665.74
mean_positive_1mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo no último mês.

Exemplo: 1827.36
mean_positive_3mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos três meses.

Exemplo: 1881.58
mean_positive_6mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos seis meses.

Exemplo: 2102.19
mean_positive_12mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos doze meses.

Exemplo: 2502.06
mean_negative_3dnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos três dias.

Exemplo: 3373.48
mean_negative_1wnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo na última semana.

Exemplo: 2477.04
mean_negative_1mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo no último mês.

Exemplo: 1904.96
mean_negative_3mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos três meses.

Exemplo: 1838.47
mean_negative_6mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos seis meses.

Exemplo: 1877.63
mean_negative_12mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos doze meses.

Exemplo: 1948.51
sum_positive_3dnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três dias.

Exemplo: 5642.16
sum_positive_1wnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo na última semana.

Exemplo: 13325.92
sum_positive_1mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo no último mês.

Exemplo: 52993.36
sum_positive_3mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três meses.

Exemplo: 163697.28
sum_positive_6mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos seis meses.

Exemplo: 189197.28
sum_positive_12mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos doze meses.

Exemplo: 240197.28
sum_positive_trend_3dnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três dias.

Exemplo: 98.902
sum_positive_trend_1wnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas na última semana.

Exemplo: -84.0393
sum_positive_trend_1mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas no último mês.

Exemplo: 22.7315
sum_positive_trend_3mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três meses.

Exemplo: 1.8398
sum_positive_trend_6mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos seis meses.

Exemplo: -17.1869
sum_positive_trend_12mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos doze meses.

Exemplo: -25.9856
sum_negative_3dnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três dias.

Exemplo: 6746.95
sum_negative_1wnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo na última semana.

Exemplo: 14862.25
sum_negative_1mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo no último mês.

Exemplo: 55243.82
sum_negative_3mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três meses.

Exemplo: 158108.77
sum_negative_6mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos seis meses.

Exemplo: 167108.77
sum_negative_12mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos doze meses.

Exemplo: 185108.77
sum_negative_trend_3dnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três dias.

Exemplo: -3.91
sum_negative_trend_1wnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas na última semana.

Exemplo: 254.2517
sum_negative_trend_1mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas no último mês.

Exemplo: 58.376
sum_negative_trend_3mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três meses.

Exemplo: 2.5895
sum_negative_trend_6mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos seis meses.

Exemplo: -1.4824
sum_negative_trend_12mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos doze meses.

Exemplo: -4.2394
positive_to_negative_ratio_3dnumber or null(float)obrigatório

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.

Exemplo: 0.84
positive_to_negative_ratio_1wnumber or null(float)obrigatório

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.

Exemplo: 0.9
positive_to_negative_ratio_1mnumber or null(float)obrigatório

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.

Exemplo: 0.96
positive_to_negative_ratio_3mnumber or null(float)obrigatório

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.

Exemplo: 1.04
positive_to_negative_ratio_6mnumber or null(float)obrigatório

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.

Exemplo: 1.13
positive_to_negative_ratio_12mnumber or null(float)obrigatório

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.

Exemplo: 1.3
net_cashflow_3dnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos três dias.

Exemplo: -1104.79
net_cashflow_1wnumber or null(float)obrigatório

O fluxo de caixa líquido na última semana.

Exemplo: -1536.33
net_cashflow_1mnumber or null(float)obrigatório

O fluxo de caixa líquido no último mês.

Exemplo: -2250.46
net_cashflow_3mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos três meses.

Exemplo: 5588.51
net_cashflow_6mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos seis meses.

Exemplo: 22088.51
net_cashflow_12mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos doze meses.

Exemplo: 55088.51
net_cashflow_trend_3dnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos três dias meses.

Exemplo: 1448.683
net_cashflow_trend_1wnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido na última semana.

Exemplo: 163.8856
net_cashflow_trend_1mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido no último mês.

Exemplo: 1.3034
net_cashflow_trend_3mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos três meses.

Exemplo: -0.472
net_cashflow_trend_6mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos seis meses.

Exemplo: -15.1286
net_cashflow_trend_12mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos doze meses.

Exemplo: -21.5511
category_metricsArray of objectsobrigatório

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.

categorystring or null

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 & Utilities
  • Credits & Loans
  • Deposits
  • Fees & Charges
  • Food & Groceries
  • Home & Life
  • Income & Payments
  • Insurance
  • Investments & Savings
  • Online Platforms & Leisure
  • Personal Shopping
  • Taxes
  • Transfers
  • Transport & Travel
  • Unknown*
  • Withdrawal & ATM
  • null

* Para clientes que não utilizam nosso produto de Categorização de Transações, retornamos null em vez disso.

Enum"Bills & Utilities""Credits & Loans""Deposits""Fees & Charges""Food & Groceries""Home & Life""Income & Payments""Insurance""Investments & Savings""Online Platforms & Leisure"
Exemplo: "Income & Payments"
subcategorystring or null

A subcategoria da transação.

Obter categorização de transações
Para clientes que não utilizam nossa Categorização de Transações, retornamos null em vez disso. Para habilitar este recurso, basta entrar em contato conosco, e nós cuidaremos disso.

Retornamos um dos seguintes valores de enum:

  • Electricity & Energy
  • Rent
  • Telecommunications
  • Water
  • Auto
  • Credit Card
  • Instalment
  • Interest & Charges
  • Mortgage
  • Pay Advance
  • Personal
  • Adjustments
  • Bank Fees
  • Chargeback
  • Refund
  • Blocked Balances
  • Alimony
  • Alcohol & Tobacco
  • Bakery & Coffee
  • Bars & Nightclubs
  • Convenience Store
  • Delivery
  • Groceries
  • Restaurants
  • Education
  • Gyms & Fitness
  • Hair & Beauty
  • Health
  • Home Decor & Appliances
  • Laundry & Dry Cleaning
  • Pharmacies
  • Professional Services
  • Veterinary Services
  • Freelance
  • Interest
  • Retirement
  • Salary
  • Government
  • Home Insurance
  • Auto Insurance
  • Health & Life Insurance
  • Savings
  • Fixed income
  • Equity
  • Investment Funds
  • Derivatives
  • Cryptocurrencies
  • Apps, Software and Cloud Services
  • Events, Parks and Museums
  • Gambling
  • Gaming
  • Lottery
  • Movie & Audio
  • Books & News
  • Clothing & Accessories
  • Department Store
  • Electronics
  • E-commerce
  • Gifts
  • Office Supplies
  • Pet Supplies
  • Auto Tax & Fees
  • Donation
  • Government Fees
  • Income Tax
  • Real Estate Tax & Fees
  • Tax Return
  • Accommodation
  • Auto Expenses
  • Auto Rental
  • Flights
  • Gas
  • Mileage Programs
  • Parking & Tolls
  • Public Transit
  • Taxis & Rideshares
  • Other
  • null
Enum"Electricity & Energy""Rent""Telecommunications""Water""Auto""Credit Card""Instalment""Interest & Charges""Mortgage""Pay Advance"
Exemplo: "Freelance"
net_amount_3mnumber or null(float)

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

Exemplo: 642.76
category_inflow_ratio_3mnumber or null(float)

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.

Exemplo: 1
trend_3mnumber or null(float)

A tendência de transações líquidas da categoria (transações de entrada - transações de saída para a categoria) para o período.

Exemplo: 0
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "accounts": [ "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "00293c8e-1152-440b-9892-3c071fb88672", "cf638fba-ef45-4c10-bc6f-adecc4b2bf4e", "3861a5da-ae9b-4f20-a632-a9294489d5ac", "1f60315b-236d-498e-be7a-92bc613d329b", "a2c8da63-ed51-41e6-891a-4ae7e784463a" ], "assets_metrics": { "institutions": [], "num_assets_accounts": 1, "num_checking_accounts": 1, "num_savings_accounts": 1, "checking_accounts_balance": 35901.46, "savings_accounts_balance": 300.02 }, "credit_cards_metrics": { "num_accounts": 2, "sum_credit_limit": 106560, "sum_credit_used": 101020.14, "credit_card_limit_utilization": 0.95 }, "loans_metrics": { "num_accounts": 1, "sum_loans_principal": 5000, "sum_loans_outstanding_principal": 2000, "sum_loans_monthly_payment": 400, "loan_limit_utilization": 0.3, "overdraft_limit": 900, "overdraft_limit_utilization": 0.4 }, "balances_metrics": { "closing_balance": 35901.46, "min_balance_3d": 35417.68, "min_balance_1w": 34150.5, "min_balance_1m": 33990.59, "min_balance_3m": 33990.59, "min_balance_6m": 33990.59, "min_balance_12m": 33990.59, "mean_balance_3d": 35659.57, "mean_balance_1w": 35077.1, "mean_balance_1m": 34816.08, "mean_balance_3m": 34816.08, "mean_balance_6m": 34816.08, "mean_balance_12m": 34816.08, "max_balance_3d": 35901.46, "max_balance_1w": 35901.46, "max_balance_1m": 35901.46, "max_balance_3m": 35901.46, "max_balance_6m": 35901.46, "max_balance_12m": 35901.46, "std_balance_3d": 279.31, "std_balance_1w": 764.03, "std_balance_1m": 586.55, "std_balance_3m": 586.55, "std_balance_6m": 586.55, "std_balance_12m": 586.55, "balance_trend_3d": 193.51, "balance_trend_1w": 290.18, "balance_trend_1m": 22.6, "balance_trend_3m": 22.6, "balance_trend_6m": 22.6, "balance_trend_12m": 22.6, "days_balance_below_0_3d": 0, "days_balance_below_0_1w": 0, "days_balance_below_0_1m": 0, "days_balance_below_0_3m": 0, "days_balance_below_0_6m": 0, "days_balance_below_0_12m": 0, "days_balance_below_mean_3d": 2, "days_balance_below_mean_1w": 3, "days_balance_below_mean_1m": 17, "days_balance_below_mean_3m": 17, "days_balance_below_mean_6m": 17, "days_balance_below_mean_12m": 17, "days_balance_below_x_3d": 0, "days_balance_below_x_1w": 0, "days_balance_below_x_1m": 0, "days_balance_below_x_3m": 0, "days_balance_below_x_6m": 0, "days_balance_below_x_12m": 0, "balance_threshold_x": 1000 }, "transactions_metrics": { "num_transactions_3d": 26, "num_transactions_1w": 46, "num_transactions_1m": 168, "num_transactions_3m": 460, "num_transactions_6m": 472, "num_transactions_12m": 496, "max_num_transactions_3d": 10, "max_num_transactions_1w": 10, "max_num_transactions_1m": 18, "max_num_transactions_3m": 18, "max_num_transactions_6m": 18, "max_num_transactions_12m": 18, "mean_num_transactions_3d": 6.5, "mean_num_transactions_1w": 5.75, "mean_num_transactions_1m": 5.42, "mean_num_transactions_3m": 5.05, "mean_num_transactions_6m": 2.61, "mean_num_transactions_12m": 1.37, "num_incoming_transactions_3d": 12, "num_incoming_transactions_1w": 21, "num_incoming_transactions_1m": 80, "num_incoming_transactions_3m": 229, "num_incoming_transactions_6m": 238, "num_incoming_transactions_12m": 256, "max_num_incoming_transactions_3d": 6, "max_num_incoming_transactions_1w": 6, "max_num_incoming_transactions_1m": 10, "max_num_incoming_transactions_3m": 10, "max_num_incoming_transactions_6m": 10, "max_num_incoming_transactions_12m": 10, "mean_num_incoming_transactions_3d": 3, "mean_num_incoming_transactions_1w": 2.62, "mean_num_incoming_transactions_1m": 2.58, "mean_num_incoming_transactions_3m": 2.52, "mean_num_incoming_transactions_6m": 1.31, "mean_num_incoming_transactions_12m": 0.71, "sum_incoming_amount_3d": 17142.16, "sum_incoming_amount_1w": 24825.92, "sum_incoming_amount_1m": 75993.36, "sum_incoming_amount_3m": 198197.28, "sum_incoming_amount_6m": 223697.28, "sum_incoming_amount_12m": 274697.28, "max_incoming_amount_3d": 3000, "max_incoming_amount_1w": 3000, "max_incoming_amount_1m": 3000, "max_incoming_amount_3m": 3000, "max_incoming_amount_6m": 3000, "max_incoming_amount_12m": 3000, "mean_incoming_amount_3d": 1428.51, "mean_incoming_amount_1w": 1182.19, "mean_incoming_amount_1m": 949.92, "mean_incoming_amount_3m": 865.49, "mean_incoming_amount_6m": 939.9, "mean_incoming_amount_12m": 1073.04, "num_outgoing_transactions_3d": 14, "num_outgoing_transactions_1w": 25, "num_outgoing_transactions_1m": 88, "num_outgoing_transactions_3m": 231, "num_outgoing_transactions_6m": 234, "num_outgoing_transactions_12m": 240, "max_num_outgoing_transactions_3d": 6, "max_num_outgoing_transactions_1w": 6, "max_num_outgoing_transactions_1m": 8, "max_num_outgoing_transactions_3m": 9, "max_num_outgoing_transactions_6m": 9, "max_num_outgoing_transactions_12m": 9, "mean_num_outgoing_transactions_3d": 3.5, "mean_num_outgoing_transactions_1w": 3.12, "mean_num_outgoing_transactions_1m": 2.84, "mean_num_outgoing_transactions_3m": 2.54, "mean_num_outgoing_transactions_6m": 1.29, "mean_num_outgoing_transactions_12m": 0.66, "sum_outgoing_amount_3d": 18246.95, "sum_outgoing_amount_1w": 26362.25, "sum_outgoing_amount_1m": 78243.82, "sum_outgoing_amount_3m": 192608.77, "sum_outgoing_amount_6m": 201608.77, "sum_outgoing_amount_12m": 219608.77, "max_outgoing_amount_3d": 3000, "max_outgoing_amount_1w": 3000, "max_outgoing_amount_1m": 3000, "max_outgoing_amount_3m": 3000, "max_outgoing_amount_6m": 3000, "max_outgoing_amount_12m": 3000, "mean_outgoing_amount_3d": 1303.35, "mean_outgoing_amount_1w": 1054.49, "mean_outgoing_amount_1m": 889.13, "mean_outgoing_amount_3m": 833.8, "mean_outgoing_amount_6m": 861.58, "mean_outgoing_amount_12m": 915.04, "days_without_transactions_3d": 0, "days_without_transactions_1w": 0, "days_without_transactions_1m": 0, "days_without_transactions_3m": 0, "days_without_transactions_6m": 87, "days_without_transactions_12m": 261, "days_since_last_transaction": 0, "days_since_last_incoming_transaction": 0, "days_since_last_outgoing_transaction": 0, "days_history": 365 }, "cashflow_metrics": { "max_positive_3d": 1850.12, "max_positive_1w": 3808.99, "max_positive_1m": 4012.61, "max_positive_3m": 5001.08, "max_positive_6m": 8500, "max_positive_12m": 8500, "max_negative_3d": 3375.43, "max_negative_1w": 3375.43, "max_negative_1m": 5305.92, "max_negative_3m": 7535.85, "max_negative_6m": 7535.85, "max_negative_12m": 7535.85, "mean_positive_3d": 1410.54, "mean_positive_1w": 1665.74, "mean_positive_1m": 1827.36, "mean_positive_3m": 1881.58, "mean_positive_6m": 2102.19, "mean_positive_12m": 2502.06, "mean_negative_3d": 3373.48, "mean_negative_1w": 2477.04, "mean_negative_1m": 1904.96, "mean_negative_3m": 1838.47, "mean_negative_6m": 1877.63, "mean_negative_12m": 1948.51, "sum_positive_3d": 5642.16, "sum_positive_1w": 13325.92, "sum_positive_1m": 52993.36, "sum_positive_3m": 163697.28, "sum_positive_6m": 189197.28, "sum_positive_12m": 240197.28, "sum_positive_trend_3d": 98.902, "sum_positive_trend_1w": -84.0393, "sum_positive_trend_1m": 22.7315, "sum_positive_trend_3m": 1.8398, "sum_positive_trend_6m": -17.1869, "sum_positive_trend_12m": -25.9856, "sum_negative_3d": 6746.95, "sum_negative_1w": 14862.25, "sum_negative_1m": 55243.82, "sum_negative_3m": 158108.77, "sum_negative_6m": 167108.77, "sum_negative_12m": 185108.77, "sum_negative_trend_3d": -3.91, "sum_negative_trend_1w": 254.2517, "sum_negative_trend_1m": 58.376, "sum_negative_trend_3m": 2.5895, "sum_negative_trend_6m": -1.4824, "sum_negative_trend_12m": -4.2394, "positive_to_negative_ratio_3d": 0.84, "positive_to_negative_ratio_1w": 0.9, "positive_to_negative_ratio_1m": 0.96, "positive_to_negative_ratio_3m": 1.04, "positive_to_negative_ratio_6m": 1.13, "positive_to_negative_ratio_12m": 1.3, "net_cashflow_3d": -1104.79, "net_cashflow_1w": -1536.33, "net_cashflow_1m": -2250.46, "net_cashflow_3m": 5588.51, "net_cashflow_6m": 22088.51, "net_cashflow_12m": 55088.51, "net_cashflow_trend_3d": 1448.683, "net_cashflow_trend_1w": 163.8856, "net_cashflow_trend_1m": 1.3034, "net_cashflow_trend_3m": -0.472, "net_cashflow_trend_6m": -15.1286, "net_cashflow_trend_12m": -21.5511 }, "category_metrics": [ {} ] }

Listar insights de risco

Requisição

▶️ Uso

Com o método List Risk Insights, você pode:

  1. Listar insights de risco relacionados a um link.id específico (usando o parâmetro de consulta link).
  2. Obter os detalhes de um risk-insight.id específico (usando o parâmetro de consulta id).
  3. [Não Recomendado] Listar todos os insights de risco relacionados à 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, veja 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/risk-insights/?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 insights de risco.

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

Recuperar insights de risco para um link

Requisição

Solicite as informações de risco para um determinado ID de link.

Se você precisar saber a moeda da conta, basta fazer um GET Details no endpoint de contas (usando o ID que você recebe da resposta das contas).

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
curl -i -X POST \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/risk-insights/?fields=string&omit=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
    "token": "1234ab",
    "save_data": true
  }'

Respostas

Ok (quando save_data=false)

Corpoapplication/json
idstring(uuid)obrigatório

Identificador único da Belvo para o item atual.

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

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
created_atstring(date-time)obrigatório

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"
accountsArray of strings or null(uuid)obrigatório

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.

Exemplo: ["0d3ffb69-f83b-456e-ad8e-208d0998d71d","00293c8e-1152-440b-9892-3c071fb88672","cf638fba-ef45-4c10-bc6f-adecc4b2bf4e","3861a5da-ae9b-4f20-a632-a9294489d5ac","1f60315b-236d-498e-be7a-92bc613d329b","a2c8da63-ed51-41e6-891a-4ae7e784463a"]
assets_metricsobject or nullobrigatório

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.

institutionsArray of strings or nullobrigatório

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.

Exemplo: ["erebor_mx_retail"]
num_assets_accountsinteger or null(int32)

O número total de contas encontradas para o usuário.

Exemplo: 1
num_checking_accountsinteger or null(int32)obrigatório

O número total de contas correntes encontradas para o usuário.

Exemplo: 1
num_savings_accountsinteger or null(int32)obrigatório

O número total de contas poupança encontradas para o usuário.

Exemplo: 1
checking_accounts_balancenumber or null(float)obrigatório

O saldo total de fechamento de todas as contas correntes.

Exemplo: 35901.46
savings_accounts_balancenumber or null(float)obrigatório

O saldo total de fechamento de todas as contas poupança.

Exemplo: 300.02
credit_cards_metricsobject or nullobrigatório

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.

num_accountsinteger(int32)>= 0obrigatório

Número de contas de cartões de crédito associadas ao usuário.

Exemplo: 2
sum_credit_limitnumber or null(float)obrigatório

Soma total de todos os limites dos cartões de crédito.

Exemplo: 106560
sum_credit_usednumber or null(float)obrigatório

Soma total de todo o crédito utilizado.

Exemplo: 101020.14
credit_card_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite do cartão de crédito utilizado.

Exemplo: 0.95
loans_metricsobject or nullobrigatório

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.

num_accountsinteger(int32)obrigatório

O número de contas de empréstimo associadas ao usuário.

Exemplo: 1
sum_loans_principalnumber or null(float)obrigatório

Soma total do principal para todas as contas de empréstimo do usuário.

Exemplo: 5000
sum_loans_outstanding_principalnumber or null(float)obrigatório

Soma total do principal pendente para todas as contas de empréstimo do usuário.

Exemplo: 2000
sum_loans_monthly_paymentnumber or null(float)obrigatório

Soma total dos pagamentos mensais de todas as contas de empréstimo do usuário.

Exemplo: 400
loan_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite do empréstimo utilizado.

Exemplo: 0.3
overdraft_limitnumber or null(float)obrigatório

O limite total de cheque especial de todas as contas correntes e de poupança.

Exemplo: 900
overdraft_limit_utilizationnumber or null(float)obrigatório

A porcentagem do limite de cheque especial utilizado.

Exemplo: 0.4
balances_metricsobject or nullobrigatório

Métricas de saldo calculadas com base nos saldos do usuário em contas correntes e de poupança.

closing_balancenumber or null(float)obrigatório

O saldo de todas as contas no momento collected_at.

Exemplo: 35901.46
min_balance_3dnumber or null(float)obrigatório

O saldo mínimo nos últimos três dias.

Exemplo: 35417.68
min_balance_1wnumber or null(float)obrigatório

O saldo mínimo na última semana).

Exemplo: 34150.5
min_balance_1mnumber or null(float)obrigatório

O saldo mínimo no último mês.

Exemplo: 33990.59
min_balance_3mnumber or null(float)obrigatório

O saldo mínimo nos últimos três meses.

Exemplo: 33990.59
min_balance_6mnumber or null(float)obrigatório

O saldo mínimo nos últimos seis meses.

Exemplo: 33990.59
min_balance_12mnumber or null(float)obrigatório

O saldo mínimo nos últimos doze meses.

Exemplo: 33990.59
mean_balance_3dnumber or null(float)obrigatório

O saldo médio nos últimos três dias.

Exemplo: 35659.57
mean_balance_1wnumber or null(float)obrigatório

O saldo médio na última semana.

Exemplo: 35077.1
mean_balance_1mnumber or null(float)obrigatório

O saldo médio no último mês.

Exemplo: 34816.08
mean_balance_3mnumber or null(float)obrigatório

O saldo médio nos últimos três meses.

Exemplo: 34816.08
mean_balance_6mnumber or null(float)obrigatório

O saldo médio nos últimos seis meses.

Exemplo: 34816.08
mean_balance_12mnumber or null(float)obrigatório

O saldo médio nos últimos doze meses.

Exemplo: 34816.08
max_balance_3dnumber or null(float)obrigatório

O saldo máximo nos últimos três dias.

Exemplo: 35901.46
max_balance_1wnumber or null(float)obrigatório

O saldo máximo na última semana.

Exemplo: 35901.46
max_balance_1mnumber or null(float)obrigatório

O saldo máximo no último mês.

Exemplo: 35901.46
max_balance_3mnumber or null(float)obrigatório

O saldo máximo nos últimos três meses.

Exemplo: 35901.46
max_balance_6mnumber or null(float)obrigatório

O saldo máximo nos últimos seis meses.

Exemplo: 35901.46
max_balance_12mnumber or null(float)obrigatório

O saldo máximo nos últimos doze meses.

Exemplo: 35901.46
std_balance_3dnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos três dias.

Exemplo: 279.31
std_balance_1wnumber or null(float)obrigatório

O desvio padrão do saldo na última semana.

Exemplo: 764.03
std_balance_1mnumber or null(float)obrigatório

O desvio padrão do saldo no último mês.

Exemplo: 586.55
std_balance_3mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos três meses.

Exemplo: 586.55
std_balance_6mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos seis meses.

Exemplo: 586.55
std_balance_12mnumber or null(float)obrigatório

O desvio padrão do saldo nos últimos doze meses.

Exemplo: 586.55
balance_trend_3dnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos três dias.

Exemplo: 193.51
balance_trend_1wnumber or null(float)obrigatório

A tendência de saldo do usuário na última semana.

Exemplo: 290.18
balance_trend_1mnumber or null(float)obrigatório

A tendência de saldo do usuário no último mês.

Exemplo: 22.6
balance_trend_3mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos três meses.

Exemplo: 22.6
balance_trend_6mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos seis meses.

Exemplo: 22.6
balance_trend_12mnumber or null(float)obrigatório

A tendência de saldo do usuário nos últimos doze meses.

Exemplo: 22.6
days_balance_below_0_3dinteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três dias.

Exemplo: 0
days_balance_below_0_1winteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 na última semana.

Exemplo: 0
days_balance_below_0_1minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 no último mês.

Exemplo: 0
days_balance_below_0_3minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos três meses.

Exemplo: 0
days_balance_below_0_6minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos seis meses.

Exemplo: 0
days_balance_below_0_12minteger or null(int32)obrigatório

O número de dias em que o saldo total da conta é menor ou igual a 0 nos últimos doze meses.

Exemplo: 0
days_balance_below_mean_3dinteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3d.

Exemplo: 2
days_balance_below_mean_1winteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1w.

Exemplo: 3
days_balance_below_mean_1minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_1m.

Exemplo: 17
days_balance_below_mean_3minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_3m.

Exemplo: 17
days_balance_below_mean_6minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_6m.

Exemplo: 17
days_balance_below_mean_12minteger or null(int32)obrigatório

O número de dias em que o saldo médio da conta é menor ou igual ao valor especificado em mean_daily_balance_12m.

Exemplo: 17
days_balance_below_x_3dinteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_1winteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_1minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_3minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_6minteger or null(int32)obrigatório

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.

Exemplo: 0
days_balance_below_x_12minteger or null(int32)obrigatório

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.

Exemplo: 0
balance_threshold_xnumber(float)obrigatório

O limite usado para calcular days_balance_below_x_period. Por favor, note que este valor é específico para cada país (tanto em termos de quantia quanto de moeda).

Exemplo: 1000
transactions_metricsobject or nullobrigatório

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 null para campos calculados e 0 para 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, _1w e _1m, no entanto:

  • mean_num_transactions_3m retornará null, pois não há dados para os meses dois e três (campo calculado).
  • num_transactions_3m retornará 0, pois não há dados para os meses dois e três (campo baseado em contagem).
num_transactions_3dinteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos três dias (entradas e saídas).

Padrão 0
Exemplo: 26
num_transactions_1winteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco da última semana (entradas e saídas).

Padrão 0
Exemplo: 46
num_transactions_1minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco do último mês (entradas e saídas).

Padrão 0
Exemplo: 168
num_transactions_3minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos três meses (entradas e saídas).

Padrão 0
Exemplo: 460
num_transactions_6minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos seis meses (entradas e saídas).

Padrão 670
Exemplo: 472
num_transactions_12minteger(int32)obrigatório

O número total de transações analisadas para determinar as percepções de risco nos últimos doze meses (entradas e saídas).

Padrão 0
Exemplo: 496
max_num_transactions_3dinteger(int32)obrigatório

O número máximo de transações nos últimos três dias.

Padrão 0
Exemplo: 10
max_num_transactions_1winteger(int32)obrigatório

O número máximo de transações da última semana.

Padrão 0
Exemplo: 10
max_num_transactions_1minteger(int32)obrigatório

O número máximo de transações do último mês.

Padrão 0
Exemplo: 18
max_num_transactions_3minteger(int32)obrigatório

O número máximo de transações nos últimos três meses.

Padrão 0
Exemplo: 18
max_num_transactions_6minteger(int32)obrigatório

O número máximo de transações nos últimos seis meses.

Padrão 0
Exemplo: 18
max_num_transactions_12minteger(int32)obrigatório

O número máximo de transações nos últimos doze meses.

Padrão 0
Exemplo: 18
mean_num_transactions_3dnumber(float)obrigatório

O número médio de transações nos últimos três dias.

Padrão 0
Exemplo: 6.5
mean_num_transactions_1wnumber(float)obrigatório

O número médio de transações da última semana.

Padrão 0
Exemplo: 5.75
mean_num_transactions_1mnumber(float)obrigatório

O número médio de transações do último mês.

Padrão 0
Exemplo: 5.42
mean_num_transactions_3mnumber(float)obrigatório

O número médio de transações nos últimos três meses.

Padrão 0
Exemplo: 5.05
mean_num_transactions_6mnumber(float)obrigatório

O número médio de transações nos últimos seis meses.

Padrão 0
Exemplo: 2.61
mean_num_transactions_12mnumber(float)obrigatório

O número médio de transações nos últimos doze meses.

Padrão 0
Exemplo: 1.37
num_incoming_transactions_3dinteger(int32)obrigatório

O número total de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 12
num_incoming_transactions_1winteger(int32)obrigatório

O número total de transações de entrada na última semana.

Padrão 0
Exemplo: 21
num_incoming_transactions_1minteger(int32)obrigatório

O número total de transações de entrada do último mês.

Padrão 0
Exemplo: 80
num_incoming_transactions_3minteger(int32)obrigatório

O número total de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 229
num_incoming_transactions_6minteger(int32)obrigatório

O número total de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 238
num_incoming_transactions_12minteger(int32)obrigatório

O número total de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 256
max_num_incoming_transactions_3dinteger(int32)obrigatório

O número máximo de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 6
max_num_incoming_transactions_1winteger(int32)obrigatório

O número máximo de transações de entrada na última semana.

Padrão 0
Exemplo: 6
max_num_incoming_transactions_1minteger(int32)obrigatório

O número máximo de transações de entrada no último mês.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_3minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_6minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 10
max_num_incoming_transactions_12minteger(int32)obrigatório

O número máximo de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 10
mean_num_incoming_transactions_3dnumber(float)obrigatório

O número médio de transações de entrada nos últimos três dias.

Padrão 0
Exemplo: 3
mean_num_incoming_transactions_1wnumber(float)obrigatório

O número médio de transações de entrada na última semana.

Padrão 0
Exemplo: 2.62
mean_num_incoming_transactions_1mnumber(float)obrigatório

O número médio de transações de entrada no último mês.

Padrão 0
Exemplo: 2.58
mean_num_incoming_transactions_3mnumber(float)obrigatório

O número médio de transações de entrada nos últimos três meses.

Padrão 0
Exemplo: 2.52
mean_num_incoming_transactions_6mnumber(float)obrigatório

O número médio de transações de entrada nos últimos seis meses.

Padrão 0
Exemplo: 1.31
mean_num_incoming_transactions_12mnumber(float)obrigatório

O número médio de transações de entrada nos últimos doze meses.

Padrão 0
Exemplo: 0.71
sum_incoming_amount_3dnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos três dias.

Exemplo: 17142.16
sum_incoming_amount_1wnumber or null(float)obrigatório

A soma total de todas as transações de entrada da última semana.

Exemplo: 24825.92
sum_incoming_amount_1mnumber or null(float)obrigatório

A soma total de todas as transações de entrada do último mês.

Exemplo: 75993.36
sum_incoming_amount_3mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos três meses.

Exemplo: 198197.28
sum_incoming_amount_6mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos seis meses.

Exemplo: 223697.28
sum_incoming_amount_12mnumber or null(float)obrigatório

A soma total de todas as transações de entrada dos últimos doze meses.

Exemplo: 274697.28
max_incoming_amount_3dnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos três dias.

Exemplo: 3000
max_incoming_amount_1wnumber or null(float)obrigatório

A transação de entrada de maior valor na última semana.

Exemplo: 3000
max_incoming_amount_1mnumber or null(float)obrigatório

A transação de entrada de maior valor no último mês.

Exemplo: 3000
max_incoming_amount_3mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos três meses.

Exemplo: 3000
max_incoming_amount_6mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos seis meses.

Exemplo: 3000
max_incoming_amount_12mnumber or null(float)obrigatório

A transação de entrada de maior valor nos últimos doze meses.

Exemplo: 3000
mean_incoming_amount_3dnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos três dias.

Exemplo: 1428.51
mean_incoming_amount_1wnumber or null(float)obrigatório

O valor médio de entrada de todas as transações na última semana.

Exemplo: 1182.19
mean_incoming_amount_1mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações no último mês.

Exemplo: 949.92
mean_incoming_amount_3mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos três meses.

Exemplo: 865.49
mean_incoming_amount_6mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos seis meses.

Exemplo: 939.9
mean_incoming_amount_12mnumber or null(float)obrigatório

O valor médio de entrada de todas as transações nos últimos doze meses.

Exemplo: 1073.04
num_outgoing_transactions_3dinteger(int32)obrigatório

Para o número total de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 14
num_outgoing_transactions_1winteger(int32)obrigatório

Para o número total de transações de saída na última semana.

Padrão 0
Exemplo: 25
num_outgoing_transactions_1minteger(int32)obrigatório

Total de transações de saída no último mês.

Padrão 0
Exemplo: 88
num_outgoing_transactions_3minteger(int32)obrigatório

Total de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 231
num_outgoing_transactions_6minteger(int32)obrigatório

Para o número total de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 234
num_outgoing_transactions_12minteger(int32)obrigatório

Total de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 240
max_num_outgoing_transactions_3dinteger(int32)obrigatório

O número máximo de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 6
max_num_outgoing_transactions_1winteger(int32)obrigatório

O número máximo de transações de saída na última semana.

Padrão 0
Exemplo: 6
max_num_outgoing_transactions_1minteger(int32)obrigatório

O número máximo de transações de saída no último mês.

Padrão 0
Exemplo: 8
max_num_outgoing_transactions_3minteger(int32)obrigatório

O número máximo de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 9
max_num_outgoing_transactions_6minteger(int32)obrigatório

O número máximo de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 9
max_num_outgoing_transactions_12minteger(int32)obrigatório

O número máximo de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 9
mean_num_outgoing_transactions_3dnumber(float)obrigatório

O número médio de transações de saída nos últimos três dias.

Padrão 0
Exemplo: 3.5
mean_num_outgoing_transactions_1wnumber(float)obrigatório

O número médio de transações de saída na última semana.

Padrão 0
Exemplo: 3.12
mean_num_outgoing_transactions_1mnumber(float)obrigatório

O número médio de transações de saída no último mês.

Padrão 0
Exemplo: 2.84
mean_num_outgoing_transactions_3mnumber(float)obrigatório

O número médio de transações de saída nos últimos três meses.

Padrão 0
Exemplo: 2.54
mean_num_outgoing_transactions_6mnumber(float)obrigatório

O número médio de transações de saída nos últimos seis meses.

Padrão 0
Exemplo: 1.29
mean_num_outgoing_transactions_12mnumber(float)obrigatório

O número médio de transações de saída nos últimos doze meses.

Padrão 0
Exemplo: 0.66
sum_outgoing_amount_3dnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos três dias.

Exemplo: 18246.95
sum_outgoing_amount_1wnumber or null(float)obrigatório

A soma total de todas as transações de saída da última semana.

Exemplo: 26362.25
sum_outgoing_amount_1mnumber or null(float)obrigatório

A soma total de todas as transações de saída do último mês.

Exemplo: 78243.82
sum_outgoing_amount_3mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos três meses.

Exemplo: 192608.77
sum_outgoing_amount_6mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos seis meses.

Exemplo: 201608.77
sum_outgoing_amount_12mnumber or null(float)obrigatório

A soma total de todas as transações de saída dos últimos doze meses.

Exemplo: 219608.77
max_outgoing_amount_3dnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos três dias.

Exemplo: 3000
max_outgoing_amount_1wnumber or null(float)obrigatório

A transação de saída de maior valor na última semana.

Exemplo: 3000
max_outgoing_amount_1mnumber or null(float)obrigatório

A transação de saída de maior valor no último mês.

Exemplo: 3000
max_outgoing_amount_3mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos três meses.

Exemplo: 3000
max_outgoing_amount_6mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos seis meses.

Exemplo: 3000
max_outgoing_amount_12mnumber or null(float)obrigatório

A transação de saída de maior valor nos últimos doze meses.

Exemplo: 3000
mean_outgoing_amount_3dnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos três dias.

Exemplo: 1303.35
mean_outgoing_amount_1wnumber or null(float)obrigatório

O valor médio de saída de todas as transações na última semana.

Exemplo: 1054.49
mean_outgoing_amount_1mnumber or null(float)obrigatório

O valor médio de saída de todas as transações no último mês.

Exemplo: 889.13
mean_outgoing_amount_3mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos três meses.

Exemplo: 833.8
mean_outgoing_amount_6mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos seis meses.

Exemplo: 861.58
mean_outgoing_amount_12mnumber or null(float)obrigatório

O valor médio de saída de todas as transações nos últimos doze meses.

Exemplo: 915.04
days_without_transactions_3dinteger(int32)obrigatório

O número de dias em que nenhuma transação ocorreu nos últimos três dias.

Padrão 0
Exemplo: 0
days_without_transactions_1winteger(int32)obrigatório

O número de dias em que não ocorreram transações na última semana.

Padrão 0
Exemplo: 0
days_without_transactions_1minteger(int32)obrigatório

O número de dias em que não ocorreram transações no último mês.

Padrão 0
Exemplo: 0
days_without_transactions_3minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos três meses.

Padrão 0
Exemplo: 0
days_without_transactions_6minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos seis meses.

Padrão 0
Exemplo: 87
days_without_transactions_12minteger(int32)obrigatório

O número de dias em que não ocorreram transações nos últimos doze meses.

Padrão 0
Exemplo: 261
days_since_last_transactioninteger(int32)obrigatório

O número de dias desde que a última transação ocorreu.

Padrão 0
Exemplo: 0
days_since_last_incoming_transactioninteger(int32)obrigatório

O número de dias desde que a última transação de entrada ocorreu.

Padrão 0
Exemplo: 0
days_since_last_outgoing_transactioninteger(int32)obrigatório

O número de dias desde que a última transação de saída ocorreu.

Padrão 0
Exemplo: 0
days_historyinteger(int32)obrigatório

O número de dias entre a solicitação de insight de risco e a primeira transação.

Padrão 0
Exemplo: 365
cashflow_metricsobject or nullobrigatório

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.

max_positive_3dnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos três dias.

Exemplo: 1850.12
max_positive_1wnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo na semana passada.

Exemplo: 3808.99
max_positive_1mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo no mês passado.

Exemplo: 4012.61
max_positive_3mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos três meses.

Exemplo: 5001.08
max_positive_6mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos seis meses.

Exemplo: 8500
max_positive_12mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa positivo nos últimos doze meses.

Exemplo: 8500
max_negative_3dnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos três dias.

Exemplo: 3375.43
max_negative_1wnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo na última semana.

Exemplo: 3375.43
max_negative_1mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo no último mês.

Exemplo: 5305.92
max_negative_3mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos três meses.

Exemplo: 7535.85
max_negative_6mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos seis meses.

Exemplo: 7535.85
max_negative_12mnumber or null(float)obrigatório

O maior valor de transações de fluxo de caixa negativo nos últimos doze meses.

Exemplo: 7535.85
mean_positive_3dnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos três dias.

Exemplo: 1410.54
mean_positive_1wnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo na última semana.

Exemplo: 1665.74
mean_positive_1mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo no último mês.

Exemplo: 1827.36
mean_positive_3mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos três meses.

Exemplo: 1881.58
mean_positive_6mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos seis meses.

Exemplo: 2102.19
mean_positive_12mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa positivo nos últimos doze meses.

Exemplo: 2502.06
mean_negative_3dnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos três dias.

Exemplo: 3373.48
mean_negative_1wnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo na última semana.

Exemplo: 2477.04
mean_negative_1mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo no último mês.

Exemplo: 1904.96
mean_negative_3mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos três meses.

Exemplo: 1838.47
mean_negative_6mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos seis meses.

Exemplo: 1877.63
mean_negative_12mnumber or null(float)obrigatório

O valor médio das transações de fluxo de caixa negativo nos últimos doze meses.

Exemplo: 1948.51
sum_positive_3dnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três dias.

Exemplo: 5642.16
sum_positive_1wnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo na última semana.

Exemplo: 13325.92
sum_positive_1mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo no último mês.

Exemplo: 52993.36
sum_positive_3mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos três meses.

Exemplo: 163697.28
sum_positive_6mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos seis meses.

Exemplo: 189197.28
sum_positive_12mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa positivo nos últimos doze meses.

Exemplo: 240197.28
sum_positive_trend_3dnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três dias.

Exemplo: 98.902
sum_positive_trend_1wnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas na última semana.

Exemplo: -84.0393
sum_positive_trend_1mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas no último mês.

Exemplo: 22.7315
sum_positive_trend_3mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos três meses.

Exemplo: 1.8398
sum_positive_trend_6mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos seis meses.

Exemplo: -17.1869
sum_positive_trend_12mnumber or null(float)obrigatório

A tendência de fluxo de caixa positivo com base na soma de todas as transações positivas nos últimos doze meses.

Exemplo: -25.9856
sum_negative_3dnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três dias.

Exemplo: 6746.95
sum_negative_1wnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo na última semana.

Exemplo: 14862.25
sum_negative_1mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo no último mês.

Exemplo: 55243.82
sum_negative_3mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos três meses.

Exemplo: 158108.77
sum_negative_6mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos seis meses.

Exemplo: 167108.77
sum_negative_12mnumber or null(float)obrigatório

O total de todas as transações que resultaram em um fluxo de caixa negativo nos últimos doze meses.

Exemplo: 185108.77
sum_negative_trend_3dnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três dias.

Exemplo: -3.91
sum_negative_trend_1wnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas na última semana.

Exemplo: 254.2517
sum_negative_trend_1mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas no último mês.

Exemplo: 58.376
sum_negative_trend_3mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos três meses.

Exemplo: 2.5895
sum_negative_trend_6mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos seis meses.

Exemplo: -1.4824
sum_negative_trend_12mnumber or null(float)obrigatório

A tendência de fluxo de caixa negativo com base na soma de todas as transações negativas nos últimos doze meses.

Exemplo: -4.2394
positive_to_negative_ratio_3dnumber or null(float)obrigatório

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.

Exemplo: 0.84
positive_to_negative_ratio_1wnumber or null(float)obrigatório

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.

Exemplo: 0.9
positive_to_negative_ratio_1mnumber or null(float)obrigatório

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.

Exemplo: 0.96
positive_to_negative_ratio_3mnumber or null(float)obrigatório

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.

Exemplo: 1.04
positive_to_negative_ratio_6mnumber or null(float)obrigatório

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.

Exemplo: 1.13
positive_to_negative_ratio_12mnumber or null(float)obrigatório

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.

Exemplo: 1.3
net_cashflow_3dnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos três dias.

Exemplo: -1104.79
net_cashflow_1wnumber or null(float)obrigatório

O fluxo de caixa líquido na última semana.

Exemplo: -1536.33
net_cashflow_1mnumber or null(float)obrigatório

O fluxo de caixa líquido no último mês.

Exemplo: -2250.46
net_cashflow_3mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos três meses.

Exemplo: 5588.51
net_cashflow_6mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos seis meses.

Exemplo: 22088.51
net_cashflow_12mnumber or null(float)obrigatório

O fluxo de caixa líquido nos últimos doze meses.

Exemplo: 55088.51
net_cashflow_trend_3dnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos três dias meses.

Exemplo: 1448.683
net_cashflow_trend_1wnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido na última semana.

Exemplo: 163.8856
net_cashflow_trend_1mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido no último mês.

Exemplo: 1.3034
net_cashflow_trend_3mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos três meses.

Exemplo: -0.472
net_cashflow_trend_6mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos seis meses.

Exemplo: -15.1286
net_cashflow_trend_12mnumber or null(float)obrigatório

A tendência do fluxo de caixa líquido nos últimos doze meses.

Exemplo: -21.5511
category_metricsArray of objectsobrigatório

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.

categorystring or null

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 & Utilities
  • Credits & Loans
  • Deposits
  • Fees & Charges
  • Food & Groceries
  • Home & Life
  • Income & Payments
  • Insurance
  • Investments & Savings
  • Online Platforms & Leisure
  • Personal Shopping
  • Taxes
  • Transfers
  • Transport & Travel
  • Unknown*
  • Withdrawal & ATM
  • null

* Para clientes que não utilizam nosso produto de Categorização de Transações, retornamos null em vez disso.

Enum"Bills & Utilities""Credits & Loans""Deposits""Fees & Charges""Food & Groceries""Home & Life""Income & Payments""Insurance""Investments & Savings""Online Platforms & Leisure"
Exemplo: "Income & Payments"
subcategorystring or null

A subcategoria da transação.

Obter categorização de transações
Para clientes que não utilizam nossa Categorização de Transações, retornamos null em vez disso. Para habilitar este recurso, basta entrar em contato conosco, e nós cuidaremos disso.

Retornamos um dos seguintes valores de enum:

  • Electricity & Energy
  • Rent
  • Telecommunications
  • Water
  • Auto
  • Credit Card
  • Instalment
  • Interest & Charges
  • Mortgage
  • Pay Advance
  • Personal
  • Adjustments
  • Bank Fees
  • Chargeback
  • Refund
  • Blocked Balances
  • Alimony
  • Alcohol & Tobacco
  • Bakery & Coffee
  • Bars & Nightclubs
  • Convenience Store
  • Delivery
  • Groceries
  • Restaurants
  • Education
  • Gyms & Fitness
  • Hair & Beauty
  • Health
  • Home Decor & Appliances
  • Laundry & Dry Cleaning
  • Pharmacies
  • Professional Services
  • Veterinary Services
  • Freelance
  • Interest
  • Retirement
  • Salary
  • Government
  • Home Insurance
  • Auto Insurance
  • Health & Life Insurance
  • Savings
  • Fixed income
  • Equity
  • Investment Funds
  • Derivatives
  • Cryptocurrencies
  • Apps, Software and Cloud Services
  • Events, Parks and Museums
  • Gambling
  • Gaming
  • Lottery
  • Movie & Audio
  • Books & News
  • Clothing & Accessories
  • Department Store
  • Electronics
  • E-commerce
  • Gifts
  • Office Supplies
  • Pet Supplies
  • Auto Tax & Fees
  • Donation
  • Government Fees
  • Income Tax
  • Real Estate Tax & Fees
  • Tax Return
  • Accommodation
  • Auto Expenses
  • Auto Rental
  • Flights
  • Gas
  • Mileage Programs
  • Parking & Tolls
  • Public Transit
  • Taxis & Rideshares
  • Other
  • null
Enum"Electricity & Energy""Rent""Telecommunications""Water""Auto""Credit Card""Instalment""Interest & Charges""Mortgage""Pay Advance"
Exemplo: "Freelance"
net_amount_3mnumber or null(float)

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

Exemplo: 642.76
category_inflow_ratio_3mnumber or null(float)

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.

Exemplo: 1
trend_3mnumber or null(float)

A tendência de transações líquidas da categoria (transações de entrada - transações de saída para a categoria) para o período.

Exemplo: 0
Resposta
application/json
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "accounts": [ "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "00293c8e-1152-440b-9892-3c071fb88672", "cf638fba-ef45-4c10-bc6f-adecc4b2bf4e", "3861a5da-ae9b-4f20-a632-a9294489d5ac", "1f60315b-236d-498e-be7a-92bc613d329b", "a2c8da63-ed51-41e6-891a-4ae7e784463a" ], "assets_metrics": { "institutions": [], "num_assets_accounts": 1, "num_checking_accounts": 1, "num_savings_accounts": 1, "checking_accounts_balance": 35901.46, "savings_accounts_balance": 300.02 }, "credit_cards_metrics": { "num_accounts": 2, "sum_credit_limit": 106560, "sum_credit_used": 101020.14, "credit_card_limit_utilization": 0.95 }, "loans_metrics": { "num_accounts": 1, "sum_loans_principal": 5000, "sum_loans_outstanding_principal": 2000, "sum_loans_monthly_payment": 400, "loan_limit_utilization": 0.3, "overdraft_limit": 900, "overdraft_limit_utilization": 0.4 }, "balances_metrics": { "closing_balance": 35901.46, "min_balance_3d": 35417.68, "min_balance_1w": 34150.5, "min_balance_1m": 33990.59, "min_balance_3m": 33990.59, "min_balance_6m": 33990.59, "min_balance_12m": 33990.59, "mean_balance_3d": 35659.57, "mean_balance_1w": 35077.1, "mean_balance_1m": 34816.08, "mean_balance_3m": 34816.08, "mean_balance_6m": 34816.08, "mean_balance_12m": 34816.08, "max_balance_3d": 35901.46, "max_balance_1w": 35901.46, "max_balance_1m": 35901.46, "max_balance_3m": 35901.46, "max_balance_6m": 35901.46, "max_balance_12m": 35901.46, "std_balance_3d": 279.31, "std_balance_1w": 764.03, "std_balance_1m": 586.55, "std_balance_3m": 586.55, "std_balance_6m": 586.55, "std_balance_12m": 586.55, "balance_trend_3d": 193.51, "balance_trend_1w": 290.18, "balance_trend_1m": 22.6, "balance_trend_3m": 22.6, "balance_trend_6m": 22.6, "balance_trend_12m": 22.6, "days_balance_below_0_3d": 0, "days_balance_below_0_1w": 0, "days_balance_below_0_1m": 0, "days_balance_below_0_3m": 0, "days_balance_below_0_6m": 0, "days_balance_below_0_12m": 0, "days_balance_below_mean_3d": 2, "days_balance_below_mean_1w": 3, "days_balance_below_mean_1m": 17, "days_balance_below_mean_3m": 17, "days_balance_below_mean_6m": 17, "days_balance_below_mean_12m": 17, "days_balance_below_x_3d": 0, "days_balance_below_x_1w": 0, "days_balance_below_x_1m": 0, "days_balance_below_x_3m": 0, "days_balance_below_x_6m": 0, "days_balance_below_x_12m": 0, "balance_threshold_x": 1000 }, "transactions_metrics": { "num_transactions_3d": 26, "num_transactions_1w": 46, "num_transactions_1m": 168, "num_transactions_3m": 460, "num_transactions_6m": 472, "num_transactions_12m": 496, "max_num_transactions_3d": 10, "max_num_transactions_1w": 10, "max_num_transactions_1m": 18, "max_num_transactions_3m": 18, "max_num_transactions_6m": 18, "max_num_transactions_12m": 18, "mean_num_transactions_3d": 6.5, "mean_num_transactions_1w": 5.75, "mean_num_transactions_1m": 5.42, "mean_num_transactions_3m": 5.05, "mean_num_transactions_6m": 2.61, "mean_num_transactions_12m": 1.37, "num_incoming_transactions_3d": 12, "num_incoming_transactions_1w": 21, "num_incoming_transactions_1m": 80, "num_incoming_transactions_3m": 229, "num_incoming_transactions_6m": 238, "num_incoming_transactions_12m": 256, "max_num_incoming_transactions_3d": 6, "max_num_incoming_transactions_1w": 6, "max_num_incoming_transactions_1m": 10, "max_num_incoming_transactions_3m": 10, "max_num_incoming_transactions_6m": 10, "max_num_incoming_transactions_12m": 10, "mean_num_incoming_transactions_3d": 3, "mean_num_incoming_transactions_1w": 2.62, "mean_num_incoming_transactions_1m": 2.58, "mean_num_incoming_transactions_3m": 2.52, "mean_num_incoming_transactions_6m": 1.31, "mean_num_incoming_transactions_12m": 0.71, "sum_incoming_amount_3d": 17142.16, "sum_incoming_amount_1w": 24825.92, "sum_incoming_amount_1m": 75993.36, "sum_incoming_amount_3m": 198197.28, "sum_incoming_amount_6m": 223697.28, "sum_incoming_amount_12m": 274697.28, "max_incoming_amount_3d": 3000, "max_incoming_amount_1w": 3000, "max_incoming_amount_1m": 3000, "max_incoming_amount_3m": 3000, "max_incoming_amount_6m": 3000, "max_incoming_amount_12m": 3000, "mean_incoming_amount_3d": 1428.51, "mean_incoming_amount_1w": 1182.19, "mean_incoming_amount_1m": 949.92, "mean_incoming_amount_3m": 865.49, "mean_incoming_amount_6m": 939.9, "mean_incoming_amount_12m": 1073.04, "num_outgoing_transactions_3d": 14, "num_outgoing_transactions_1w": 25, "num_outgoing_transactions_1m": 88, "num_outgoing_transactions_3m": 231, "num_outgoing_transactions_6m": 234, "num_outgoing_transactions_12m": 240, "max_num_outgoing_transactions_3d": 6, "max_num_outgoing_transactions_1w": 6, "max_num_outgoing_transactions_1m": 8, "max_num_outgoing_transactions_3m": 9, "max_num_outgoing_transactions_6m": 9, "max_num_outgoing_transactions_12m": 9, "mean_num_outgoing_transactions_3d": 3.5, "mean_num_outgoing_transactions_1w": 3.12, "mean_num_outgoing_transactions_1m": 2.84, "mean_num_outgoing_transactions_3m": 2.54, "mean_num_outgoing_transactions_6m": 1.29, "mean_num_outgoing_transactions_12m": 0.66, "sum_outgoing_amount_3d": 18246.95, "sum_outgoing_amount_1w": 26362.25, "sum_outgoing_amount_1m": 78243.82, "sum_outgoing_amount_3m": 192608.77, "sum_outgoing_amount_6m": 201608.77, "sum_outgoing_amount_12m": 219608.77, "max_outgoing_amount_3d": 3000, "max_outgoing_amount_1w": 3000, "max_outgoing_amount_1m": 3000, "max_outgoing_amount_3m": 3000, "max_outgoing_amount_6m": 3000, "max_outgoing_amount_12m": 3000, "mean_outgoing_amount_3d": 1303.35, "mean_outgoing_amount_1w": 1054.49, "mean_outgoing_amount_1m": 889.13, "mean_outgoing_amount_3m": 833.8, "mean_outgoing_amount_6m": 861.58, "mean_outgoing_amount_12m": 915.04, "days_without_transactions_3d": 0, "days_without_transactions_1w": 0, "days_without_transactions_1m": 0, "days_without_transactions_3m": 0, "days_without_transactions_6m": 87, "days_without_transactions_12m": 261, "days_since_last_transaction": 0, "days_since_last_incoming_transaction": 0, "days_since_last_outgoing_transaction": 0, "days_history": 365 }, "cashflow_metrics": { "max_positive_3d": 1850.12, "max_positive_1w": 3808.99, "max_positive_1m": 4012.61, "max_positive_3m": 5001.08, "max_positive_6m": 8500, "max_positive_12m": 8500, "max_negative_3d": 3375.43, "max_negative_1w": 3375.43, "max_negative_1m": 5305.92, "max_negative_3m": 7535.85, "max_negative_6m": 7535.85, "max_negative_12m": 7535.85, "mean_positive_3d": 1410.54, "mean_positive_1w": 1665.74, "mean_positive_1m": 1827.36, "mean_positive_3m": 1881.58, "mean_positive_6m": 2102.19, "mean_positive_12m": 2502.06, "mean_negative_3d": 3373.48, "mean_negative_1w": 2477.04, "mean_negative_1m": 1904.96, "mean_negative_3m": 1838.47, "mean_negative_6m": 1877.63, "mean_negative_12m": 1948.51, "sum_positive_3d": 5642.16, "sum_positive_1w": 13325.92, "sum_positive_1m": 52993.36, "sum_positive_3m": 163697.28, "sum_positive_6m": 189197.28, "sum_positive_12m": 240197.28, "sum_positive_trend_3d": 98.902, "sum_positive_trend_1w": -84.0393, "sum_positive_trend_1m": 22.7315, "sum_positive_trend_3m": 1.8398, "sum_positive_trend_6m": -17.1869, "sum_positive_trend_12m": -25.9856, "sum_negative_3d": 6746.95, "sum_negative_1w": 14862.25, "sum_negative_1m": 55243.82, "sum_negative_3m": 158108.77, "sum_negative_6m": 167108.77, "sum_negative_12m": 185108.77, "sum_negative_trend_3d": -3.91, "sum_negative_trend_1w": 254.2517, "sum_negative_trend_1m": 58.376, "sum_negative_trend_3m": 2.5895, "sum_negative_trend_6m": -1.4824, "sum_negative_trend_12m": -4.2394, "positive_to_negative_ratio_3d": 0.84, "positive_to_negative_ratio_1w": 0.9, "positive_to_negative_ratio_1m": 0.96, "positive_to_negative_ratio_3m": 1.04, "positive_to_negative_ratio_6m": 1.13, "positive_to_negative_ratio_12m": 1.3, "net_cashflow_3d": -1104.79, "net_cashflow_1w": -1536.33, "net_cashflow_1m": -2250.46, "net_cashflow_3m": 5588.51, "net_cashflow_6m": 22088.51, "net_cashflow_12m": 55088.51, "net_cashflow_trend_3d": 1448.683, "net_cashflow_trend_1w": 163.8856, "net_cashflow_trend_1m": 1.3034, "net_cashflow_trend_3m": -0.472, "net_cashflow_trend_6m": -15.1286, "net_cashflow_trend_12m": -21.5511 }, "category_metrics": [ {} ] }

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