Accounts

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

Detalhes sobre a conta.

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"

institutionobjectobrigatório

Detalhes sobre a instituição.

namestring

O nome da instituição, conforme designado pela Belvo.

Exemplo: "erebor_mx_retail"

typestring

O tipo de instituição. Retornamos um dos seguintes valores:

bank
fiscal
employment

Enum"bank""fiscal""employment"

collected_atstring(date-time)obrigatório

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

Exemplo: "2022-02-09T08:45:50.406032Z"

created_atstring(date-time)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"

last_accessed_atstring or null(date-time)obrigatório

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

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

categorystring or nullobrigatório

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

ADVANCE_DEPOSIT_ACCOUNT
CHECKING_ACCOUNT
CREDIT_CARD
FINANCING_ACCOUNT
INVESTMENT_ACCOUNT
INVOICE_FINANCING_ACCOUNT
LOAN_ACCOUNT
PENSION_FUND_ACCOUNT
SAVINGS_ACCOUNT
UNCATEGORIZED

Enum"ADVANCE_DEPOSIT_ACCOUNT""CHECKING_ACCOUNT""CREDIT_CARD""FINANCING_ACCOUNT""INVESTMENT_ACCOUNT""INVOICE_FINANCING_ACCOUNT""LOAN_ACCOUNT""PENSION_FUND_ACCOUNT""SAVINGS_ACCOUNT""UNCATEGORIZED"

Exemplo: "CHECKING_ACCOUNT"

balance_typestring or nullobrigatório

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

Exemplo: "ASSET"

overdraftobject or null

typestringobrigatório

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

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "STANDARD_NACIONAL"

subtypestringobrigatório

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

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "FINANCIAMENTO_HABITACIONAL_SFH"

namestring or nullobrigatório

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

Exemplo: "Cuenta Perfiles- M.N. - MXN-666"

numberstring or nullobrigatório

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

Exemplo: "4057068115181"

agencystring or null<= 4 characters^\d{1,4}$obrigatório

O código da agência onde o produto foi aberto.

Exemplo: "6272"

check_digitstring or null<= 2 characters[\w\W\s]*obrigatório

O dígito verificador do número do produto, se aplicável.

Exemplo: "7"

balanceobjectobrigatório

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

currentnumber or null(float)^\d{1,15}\.\d{2,4}$obrigatório

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

💰 Contas correntes e poupança:

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

💳 Cartões de crédito:

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

🏡 Contas de empréstimo:

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

Exemplo: 5874.13

availablenumber or null(float)^\d{1,15}\.\d{2,4}$

O saldo que o titular da conta pode usar.

💰 Contas correntes e poupança:

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

💳 Cartões de crédito:

O valor de crédito que o usuário ainda tem disponível para o período atual. O valor é calculado como credit_data.credit_limit menos balance.current.

🏡 Contas de empréstimo:

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

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

Exemplo: 5621.12

blockednumber(float)^\d{1,15}\.\d{2,4}$

O valor que está atualmente bloqueado devido a transações pendentes.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo balances estiver disponível.

Exemplo: 60.32

automatically_investednumber(float)^\d{1,15}\.\d{2,4}$

O valor que é automaticamente investido (conforme acordado com a instituição).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo balances estiver disponível.

Exemplo: 131.5

currencystring<= 3 characters^[A-Z]{3}$obrigatório

O código de moeda de três letras (ISO-4217).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo balances estiver disponível.

Exemplo: "BRL"

public_identification_namestring or nullobrigatório

O nome público para o tipo de identificação. Para contas de poupança e corrente brasileiras 🇧🇷, este campo será AGENCY/ACCOUNT.

Exemplo: "AGENCY/ACCOUNT"

public_identification_valuestring or nullobrigatório

O valor para o public_identification_name.

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

Para contas de cartão de crédito 🇧🇷 OFDA brasileiras, retornaremos uma string de números de cartão de crédito concatenados associados à conta. Por exemplo: "8763,9076,5522"

Exemplo: "0444/45722-0"

internal_identificationstring<= 100 characters^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$obrigatório

A identificação interna da instituição para a conta.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo balances estiver disponível.

Exemplo: "92792126019929279212650822221989319252576"

credit_dataobject or nullobrigatório

Detalhes sobre os cartões de crédito associados a esta conta.

collected_atstring(date-time)obrigatório

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

Exemplo: "2022-02-09T08:45:50.406032Z"

credit_limitnumber or null(float)<= 20 characters^\d{1,15}\.\d{2,4}$obrigatório

O limite de crédito superior do cartão.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: 192000.9

limitsArray of objects

cutting_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...

A data de vencimento da fatura do cartão de crédito.

Exemplo: "2019-12-11"

minimum_paymentnumber or null(float)<= 20 characters^\d{1,15}\.\d{2,4}$

O valor mínimo que o proprietário da conta precisa pagar no período de crédito atual.

Exemplo: 2400.3

networkstring

A rede de crédito à qual o cartão está associado. Retornamos um dos seguintes valores:

VISA
MASTERCARD
AMERICAN_EXPRESS
DINERS_CLUB
HIPERCARD
BANDEIRA_PROPRIA
CHEQUE_ELETRONICO
ELO
OTHER

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"VISA""MASTERCARD""AMERICAN_EXPRESS""DINERS_CLUB""HIPERCARD""BANDEIRA_PROPRIA""CHEQUE_ELETRONICO""ELO""OTHER"

Exemplo: "MASTERCARD"

network_additional_infostring or null<= 100 characters[\w\W\s]*

Informações adicionais sobre a rede de cartão de crédito.

Exemplo: "It's an orange card."

cardsArray of objectsnon-empty

Detalhes sobre os cartões associados à conta.

next_payment_datestring or null

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

no_interest_paymentnumber or null(float)

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

interest_ratenumber or null(float)

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

monthly_paymentnumber or nullObsoleto

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

last_payment_datestring or nullObsoleto

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

loan_dataobject or nullobrigatório

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

collected_atstring(date-time)obrigatório

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

Exemplo: "2022-02-09T08:45:50.406032Z"

loan_codestring[ 22 .. 67 ] characters^\d{22,67}$obrigatório

O número de contrato padronizado específico do país.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "92792126019929279212650822221989319252576"

contract_amountnumber or null(float)^\d{1,15}\.\d{2,4}$obrigatório

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

Exemplo: 202000

total_effective_costnumber or null(float)^\d{1,15}\.\d{2,4}$

O custo efetivo total inicial do empréstimo.

Exemplo: 209000

loan_typestringobrigatório

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

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "HOME_EQUITY"

outstanding_balancenumber or null(float)[ 4 .. 20 ] characters^\d{1,15}\.\d{2,4}$obrigatório

O valor restante a pagar no total, incluindo juros.

Exemplo: 182000

interest_ratesArray of objectsobrigatório

Detalhamento dos juros aplicados ao empréstimo. Com o OF Brasil, recomendamos fortemente o uso das informações em interest_rate_data para obter informações detalhadas.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

namestring or nullobrigatório

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

Nota: Para OFDA Brasil, recomendamos que você use o parâmetro interest_date_data.tax_type.

Exemplo: "NOMINAL"

typestringobrigatório

O período em que o juro é aplicado ao empréstimo.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"MONTHLY""YEARLY"

Exemplo: "MONTHLY"

valuenumber or null(float)obrigatório

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

Nota: Para OFDA Brasil, recomendamos que você use os parâmetros interest_date_data.pre_fixed_rate e interest_date_data.post_fixed_rate.

Exemplo: 7.85

interest_rate_dataobject or nullobrigatório

Informações detalhadas sobre a taxa de juros.

tax_typestringobrigatório

O tipo de imposto sobre a taxa de juros. Retornamos um dos seguintes valores:

NOMINAL
EFFECTIVE

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"NOMINAL""EFFECTIVE"

Exemplo: "NOMINAL"

rate_typestringobrigatório

O tipo de taxa de juros. Retornamos um dos seguintes valores:

SIMPLE
COMPOUND

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"SIMPLE""COMPOUND"

Exemplo: "SIMPLE"

typestring

O período em que o juro é aplicado ao empréstimo.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"MONTHLY""YEARLY"

Exemplo: "MONTHLY"

calculation_basestring^[0-9]{2}\/[0-9]{3}$obrigatório

O cálculo base para a taxa de juros.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "30/360"

reference_index_typestringobrigatório

A taxa de índice de referência. Retornamos um dos seguintes valores:

WITHOUT_INDEX_TYPE
PRE_FIXED
POST_FIXED
FLOATING
INDEXED_PRICE
RURAL_CREDIT
OTHER_INDEX

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"WITHOUT_INDEX_TYPE""PRE_FIXED""POST_FIXED""FLOATING""INDEXED_PRICE""RURAL_CREDIT""OTHER_INDEX"

Exemplo: "FLOATING"

reference_index_subtypestring or nullobrigatório

O subtipo da taxa de índice de referência.

Exemplo: "TR_TBF"

reference_index_infostring or null<= 140 characters^[\w\W\s]{0,140}$obrigatório

Informações adicionais sobre a taxa de índice de referência.

Exemplo: "Additional information"

pre_fixed_ratenumber(float)^[01]\.\d{6}$obrigatório

A taxa de juros com percentual prefixado.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: 0.062

post_fixed_ratenumber(float)^[01]\.\d{6}$obrigatório

A taxa de juros com percentual pós-fixado.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: 0.062

additional_infostring or null<= 1200 characters[\w\W\s]*obrigatório

Informações adicionais sobre a taxa de juros.

Exemplo: "Additional information"

feesArray of objects or null or nullobrigatório

Detalhamento das taxas aplicadas ao empréstimo.

typestring or nullobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Enum"OPERATION_FEE""INSURANCE_FEE""OTHERS"null

Exemplo: null

valuenumber or null(float)^\d{1,15}\.\d{2,4}$obrigatório

O valor total da taxa. Mesma moeda do empréstimo.

Exemplo: 5.6

namestring<= 140 characters^[\w\W\s]{0,140}$obrigatório

O nome da taxa.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.

Exemplo: "Renovação de cadastro"

codestring<= 140 characters^[\w\W\s]{0,140}$obrigatório

O código de tarifa.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.

Exemplo: "CADASTRO"

fee_charge_typestringobrigatório

Indica o tipo de cobrança. Retornamos um dos seguintes valores:

SINGLE
PER_INSTALLMENT

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.

Enum"SINGLE""PER_INSTALLMENT"

Exemplo: "SINGLE"

fee_chargestringobrigatório

Método de cobrança, conforme acordado com a instituição. Retornamos um dos seguintes valores:

MINIMUM
MAXIMUM
FIXED
PERCENTAGE

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.

Enum"MINIMUM""MAXIMUM""FIXED""PERCENTAGE"

Exemplo: "FIXED"

ratenumber or null(float)^[01]\.\d{6}$obrigatório

A taxa percentual da tarifa. Necessária quando fee_charge está definido como PERCENTAGE.

Exemplo: 0.062

contracted_chargesArray of objects or null or null

Parece que você não forneceu nenhum texto para tradução. Por favor, envie o texto que deseja que eu traduza do inglês para o português (Brasil).

collateralsArray of objects or null or nullobrigatório

Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou empresa forneceu.

typestringobrigatório

O tipo de garantia, conforme definido pela instituição.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo collaterals estiver disponível.

Exemplo: "OPERACOES_GARANTIDAS_PELO_GOVERNO"

subtypestringobrigatório

O subtipo da garantia, conforme definido pela instituição.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo collaterals estiver disponível.

Exemplo: "CCR_CONVENIO_CREDITOS_RECIPROCOS"

currencystring<= 3 characters^[A-Z]{3}$obrigatório

O código de moeda de três letras (ISO-4217).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo collaterals estiver disponível.

Exemplo: "BRL"

amountnumber(float)^\d{1,15}\.\d{2,4}$obrigatório

O valor total da fatura.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo collaterals estiver disponível.

Exemplo: 45391.89

balloon_paymentsArray of objects or null or nullobrigatório

Informações detalhadas sobre quaisquer pagamentos de balloon para o empréstimo, se aplicável.

due_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que o pagamento do balloon deve ser efetuado, no formato YYYY-MM-DD.

Exemplo: "2021-09-06"

currencystring or null<= 3 characters^[A-Z]{3}$obrigatório

O código de moeda de três letras (ISO-4217).

Exemplo: "BRL"

amountnumber or null(float)^\d{1,15}\.\d{2,4}$obrigatório

O valor total do pagamento final.

Exemplo: 45391.89

installments_contract_term_frequencystring or nullobrigatório

A frequência dos pagamentos parcelados contratados, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes:

DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null

Enum"DAY""WEEK""MONTH""YEAR""NO_DEADLINE_REMAINING"null

Exemplo: "MONTH"

installment_frequencystringobrigatório

A frequência com que as parcelas são pagas. Retornamos um dos seguintes valores:

IRREGULAR
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHER

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Enum"IRREGULAR""WEEKLY""FORTNIGHTLY""MONTHLY""BIMONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY""OTHER"

Exemplo: "MONTHLY"

installment_frequency_infostring or null<= 100 characters^[\w\W\s]{0,99}$$obrigatório

Informações adicionais sobre o installment_frequency.

Exemplo: "Both the term and requency are the same."

first_installment_due_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que a primeira parcela do empréstimo deve ser paga, no formato YYYY-MM-DD.

Exemplo: "2020-03-01"

number_of_installments_totalinteger or null(int32)<= 999999999obrigatório

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

Exemplo: 60

number_of_installments_outstandinginteger or null(int32)<= 999999999obrigatório

O número de parcelas restantes a pagar.

Exemplo: 48

number_of_installments_paidinteger or null(int32)<= 999999999obrigatório

O número de parcelas já pagas.

Exemplo: 32

number_of_installments_past_dueinteger or null(int32)<= 999obrigatório

O número de parcelas que estão em atraso.

Exemplo: 2

disbursement_datesArray of strings or null or nullnon-emptyobrigatório

Um array de datas em que o empréstimo foi desembolsado.

Exemplo: ["2021-09-23"]

settlement_datestring or null<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

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

Exemplo: "2021-09-23"

contract_start_datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

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

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "2020-03-01"

contract_end_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

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

Exemplo: "2027-10-01"

contract_remaining_frequencystring or nullobrigatório

A frequência dos pagamentos das parcelas restantes contratadas, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes valores:

DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null

Enum"DAY""WEEK""MONTH""YEAR""NO_DEADLINE_REMAINING"null

Exemplo: "MONTH"

contract_remaining_totalinteger or null(int32)<= 999999999obrigatório

O número total de parcelas restantes no empréstimo.

Exemplo: 20

amortization_schedulestringobrigatório

O cronograma de amortização do empréstimo.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "SEM_SISTEMA_AMORTIZACAO"

amortization_schedule_infostring or null<= 200 characters[\w\W\s]*obrigatório

Informações adicionais sobre o amortization_schedule.

Exemplo: "No need for a schedule."

consignee_idstring or null<= 14 characters^\d{14}$obrigatório

O ID do consignatário do empréstimo.

Exemplo: "60500998000135"

contract_numberstring or null[ 1 .. 100 ] characters^\d{1,100}$obrigatório

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

Exemplo: "1324926521496"

monthly_paymentnumber or null(float)obrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

principalnumber or null(float)obrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

payment_daystring or nullobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

outstanding_principalnumber or null(float)obrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

credit_limitnumber or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

last_period_balancenumber or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

interest_ratenumber or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

limit_daystring or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

cutting_daystring or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

cutting_datestring or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

last_payment_datestring or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

no_interest_paymentnumber or nullObsoletoobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

funds_datastring or nullobrigatório

Nota: Este campo não se aplica ao OF Brasil e retornará null.

Exemplo: null

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "institution": {
    "name": "erebor_mx_retail",
    "type": "bank"
  },
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "last_accessed_at": "2021-03-09T10:28:40.000Z",
  "category": "CHECKING_ACCOUNT",
  "balance_type": "ASSET",
  "overdraft": {
    "arranged": 5000.5,
    "used": 1000.5,
    "unarranged": 300.1
  },
  "type": "STANDARD_NACIONAL",
  "subtype": "FINANCIAMENTO_HABITACIONAL_SFH",
  "name": "Cuenta Perfiles- M.N. - MXN-666",
  "number": "4057068115181",
  "agency": "6272",
  "check_digit": "7",
  "balance": {
    "current": 5874.13,
    "available": 5621.12,
    "blocked": 60.32,
    "automatically_invested": 131.5
  },
  "currency": "BRL",
  "public_identification_name": "AGENCY/ACCOUNT",
  "public_identification_value": "0444/45722-0",
  "internal_identification": "92792126019929279212650822221989319252576",
  "credit_data": {
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "credit_limit": 192000.9,
    "limits": [ … ],
    "cutting_date": "2019-12-11",
    "minimum_payment": 2400.3,
    "network": "MASTERCARD",
    "network_additional_info": "It's an orange card.",
    "cards": [ … ],
    "next_payment_date": null,
    "no_interest_payment": null,
    "interest_rate": null,
    "monthly_payment": null,
    "last_payment_date": null
  },
  "loan_data": {
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "loan_code": "92792126019929279212650822221989319252576",
    "contract_amount": 202000,
    "total_effective_cost": 209000,
    "loan_type": "HOME_EQUITY",
    "outstanding_balance": 182000,
    "interest_rates": [ … ],
    "fees": [ … ],
    "contracted_charges": [ … ],
    "collaterals": [ … ],
    "balloon_payments": [ … ],
    "installments_contract_term_frequency": "MONTH",
    "installment_frequency": "MONTHLY",
    "installment_frequency_info": "Both the term and requency are the same.",
    "first_installment_due_date": "2020-03-01",
    "number_of_installments_total": 60,
    "number_of_installments_outstanding": 48,
    "number_of_installments_paid": 32,
    "number_of_installments_past_due": 2,
    "disbursement_dates": [ … ],
    "settlement_date": "2021-09-23",
    "contract_start_date": "2020-03-01",
    "contract_end_date": "2027-10-01",
    "contract_remaining_frequency": "MONTH",
    "contract_remaining_total": 20,
    "amortization_schedule": "SEM_SISTEMA_AMORTIZACAO",
    "amortization_schedule_info": "No need for a schedule.",
    "consignee_id": "60500998000135",
    "contract_number": "1324926521496",
    "monthly_payment": null,
    "principal": null,
    "payment_day": null,
    "outstanding_principal": null,
    "credit_limit": null,
    "last_period_balance": null,
    "interest_rate": null,
    "limit_day": null,
    "cutting_day": null,
    "cutting_date": null,
    "last_payment_date": null,
    "no_interest_payment": null
  },
  "funds_data": null
}

Documentação da API Belvo (1.221.0)

Introdução

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

Dicionários de Dados

Ambientes

Sandbox

Produção

Códigos de Resposta

Tratamento de Erros

Identificador de Solicitação

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

Política de Repetição

Erros 50x

Erros 40x

Campos Obsoletos

OpenAPI: campos obrigatórios e anuláveis

Institutions

Links

Widget Access Token

Consents

Owners

Accounts

Objeto Account (OFDA Brasil)

Listar contas

Requisição

▶️ Uso

🔦 Filtrando Respostas

📖 Paginação

🚨 Campos Obsoletos

Respostas

Quão útil foi esta página?

Recuperar contas para um link

Requisição

Respostas

Quão útil foi esta página?

Balances

Transactions

Bills

Investments Brazil

Investment Transactions Brazil

Employments Brazil

Employment Records Mexico

Invoices

Tax compliance status

Tax returns

Tax retentions

Tax status

Financial Statements

Invoices Chile

Tax Status Chile

Debt Reports Chile

Incomes

Recurring Expenses

Risk Insights

Employment Metrics

Payment Institutions (Brazil)

Customers (Brazil)

Bank Accounts (Brazil)

Payment Links (Brazil)

Payment Intents (Brazil)

Payment Authorizations (Brazil)

Biometric Pix Widget Access Token (Brazil)

Enrollments (Brazil)

Payment Transactions (Brazil)