Accounts

Status Code	Description
`200`	✅ Success - The content is available in the response body.
`201`	✅ Success - The content was created successfully on Belvo.
`204`	✅ Success - No content to return.
`400`	❌ Bad Request Error - Request returned an error, detail in the content.
`401`	❌ Unauthorized - The Belvo credentials provided are not valid.
`404`	❌ Not Found - The resource you try to access cannot be found.
`405`	❌ Method Not Allowed - The HTTP method you are using is not accepted for this resource.
`408`	❌ Request Timeout - The request timed out and was terminated by the server.
`428`	❌ MFA Token Required - MFA token was required by the institution to connect.
`500`	❌ Internal Server Error - The detail of the error is available in the response body.

Details regarding the account.

idstring(uuid)required

Belvo's unique identifier for the current item.

Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

linkstring or null(uuid)required

The link.id the data belongs to.

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

institutionobjectrequired

Details regarding the institution.

namestring

The name of the institution, as designated by Belvo.

Example: "erebor_mx_retail"

typestring

The type of institution. We return one of the following values:

bank
fiscal
employment

Enum"bank""fiscal""employment"

collected_atstring(date-time)required

The ISO-8601 timestamp when the data point was collected.

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

created_atstring(date-time)required

The ISO-8601 timestamp of when the data point was created in Belvo's database.

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

last_accessed_atstring or null(date-time)required

The ISO-8601 timestamp of Belvo's most recent successful access to the institution for the given link.

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

categorystring or nullrequired

The type of account. We return one of the following enum values:

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"

Example: "CHECKING_ACCOUNT"

balance_typestring or nullrequired

Indicates whether this account is either an ASSET or a LIABILITY. You can consider the balance of an ASSET as being positive, while the balance of a LIABILITY as negative.

Example: "ASSET"

overdraftobject or null

typestringrequired

The account type, as designated by the institution.

Example: "STANDARD_NACIONAL"

subtypestringrequired

The account subtype, as designated by the institution.

Example: "FINANCIAMENTO_HABITACIONAL_SFH"

namestring or nullrequired

The account name, as given by the institution.

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

numberstring or nullrequired

The account number, as designated by the institution.

Example: "4057068115181"

agencystring or null<= 4 characters^\d{1,4}$required

The branch code where the product was opened.

Example: "6272"

check_digitstring or null<= 2 characters[\w\W\s]*required

The check digit of the product's number, if applicable.

Example: "7"

balanceobjectrequired

Details regarding the current and available balances for the account.

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

The current balance is calculated differently according to the type of account.

💰 Checking and saving accounts:

The user's account balance at the collected_at timestamp.

💳 Credit cards:

The amount the user has spent in the current card billing period (see credit_data.cutting_date for information on when the current billing period finishes).

🏡 Loan accounts:

The amount remaining to pay on the users's loan.

Example: 5874.13

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

The balance that the account owner can use.

💰 Checking and saving accounts:

The available balance may be different to the current balance due to pending transactions.

💳 Credit cards:

The credit amount the user still has available for the current period. The amount is calculated as credit_data.credit_limit minus balance.current.

🏡 Loan accounts:

The present value required to pay off the loan, as provided by the institution.

Note: If the institution does not provide this value, we return null.

Example: 5621.12

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

The amount that is currently blocked due to pending transactions.

Example: 60.32

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

The amount that is automatically invested (as agreed upon with the institution).

Example: 131.5

currencystring<= 3 characters^[A-Z]{3}$required

The three-letter currency code (ISO-4217).

Example: "BRL"

public_identification_namestring or nullrequired

The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be AGENCY/ACCOUNT.

Example: "AGENCY/ACCOUNT"

public_identification_valuestring or nullrequired

The value for the public_identification_name.

For 🇧🇷 OFDA Brazilian savings and checking accounts, this field will be the agency and bank account number, separated by a slash. For example: 0444/45722-0.

For 🇧🇷 OFDA Brazilian credit card accounts, we will return a string of concatenated credit card numbers associated with the account. For example: "8763,9076,5522"

Example: "0444/45722-0"

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

The institution's internal identification for the account.

Example: "92792126019929279212650822221989319252576"

credit_dataobject or nullrequired

Details regarding the credit cards associated with this account.

collected_atstring(date-time)required

The ISO-8601 timestamp when the data point was collected.

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

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

The upper credit limit of the card.

Example: 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?...

The date when the credit card's bill is due.

Example: "2019-12-11"

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

The minimum amount that the account owner needs to pay in the current credit period.

Example: 2400.3

networkstring

The credit network that the card is associated with. We return one of the following values:

VISA
MASTERCARD
AMERICAN_EXPRESS
DINERS_CLUB
HIPERCARD
BANDEIRA_PROPRIA
CHEQUE_ELETRONICO
ELO
OTHER

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

Example: "MASTERCARD"

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

Additional information about the credit card network.

Example: "It's an orange card."

cardsArray of objectsnon-empty

Details regarding the cards associated with the account.

next_payment_datestring or null

Note: This field is not applicable for OF Brazil and will return null.

Example: null

no_interest_paymentnumber or null(float)

Note: This field is not applicable for OF Brazil and will return null.

Example: null

interest_ratenumber or null(float)

Note: This field is not applicable for OF Brazil and will return null.

Example: null

monthly_paymentnumber or nullDeprecated

Note: This field is not applicable for OF Brazil and will return null.

Example: null

last_payment_datestring or nullDeprecated

Note: This field is not applicable for OF Brazil and will return null.

Example: null

loan_dataobject or nullrequired

The loan options associated with this account.

collected_atstring(date-time)required

The ISO-8601 timestamp when the data point was collected.

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

loan_codestring[ 22 .. 67 ] characters^\d{22,67}$required

The country-specific standardized contract number.

Example: "92792126019929279212650822221989319252576"

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

The initial total loan amount when the contract was signed, calculated by the institution. This amount includes the principal + interest + taxes + fees.

Example: 202000

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

The initial total effective cost of the loan.

Example: 209000

loan_typestringrequired

The type of the loan, according to the institution.

Example: "HOME_EQUITY"

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

The amount remaining to pay in total, including interest.

Example: 182000

interest_ratesArray of objectsrequired

Breakdown of the interest applied to the loan. With OF Brazil, we highly recommend using the information in interest_rate_data for in-depth information.

namestring or nullrequired

The name of the type of interest rate applied to the loan.

Note: For OFDA Brazil, we recommend you use the interest_date_data.tax_type parameter.

Example: "NOMINAL"

typestringrequired

The period that the interest is applied to the loan.

Enum"MONTHLY""YEARLY"

Example: "MONTHLY"

valuenumber or null(float)required

The interest rate (in percent or currency value).

Note: For OFDA Brazil, we recommend you use the interest_date_data.pre_fixed_rate and interest_date_data.post_fixed_rateparameter.

Example: 7.85

interest_rate_dataobject or nullrequired

Detailed information regarding the interest rate.

tax_typestringrequired

The type of interest rate tax. We return one of the following values:

NOMINAL
EFFECTIVE

Enum"NOMINAL""EFFECTIVE"

Example: "NOMINAL"

rate_typestringrequired

The type of interest rate. We return one of the following values:

SIMPLE
COMPOUND

Enum"SIMPLE""COMPOUND"

Example: "SIMPLE"

typestring

The period that the interest is applied to the loan.

Enum"MONTHLY""YEARLY"

Example: "MONTHLY"

calculation_basestring^[0-9]{2}\/[0-9]{3}$required

The base calculation for the interest rate.

Example: "30/360"

reference_index_typestringrequired

The reference index rate. We return one of the following values:

WITHOUT_INDEX_TYPE
PRE_FIXED
POST_FIXED
FLOATING
INDEXED_PRICE
RURAL_CREDIT
OTHER_INDEX

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

Example: "FLOATING"

reference_index_subtypestring or nullrequired

The subtype of the reference index rate.

Example: "TR_TBF"

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

Additional information regarding the reference index rate.

Example: "Additional information"

pre_fixed_ratenumber(float)^[01]\.\d{6}$required

The pre-fixed percentage rate of the interest rate.

Example: 0.062

post_fixed_ratenumber(float)^[01]\.\d{6}$required

The post-fixed percentage rate of the interest rate.

Example: 0.062

additional_infostring or null<= 1200 characters[\w\W\s]*required

Additional information regarding the interest rate.

Example: "Additional information"

feesArray of objects or null or nullrequired

Breakdown of the fees applied to the loan.

typestring or nullrequired

Note: This field is not applicable for OF Brazil and will return null.

Enum"OPERATION_FEE""INSURANCE_FEE""OTHERS"null

Example: null

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

The total value of the fee. Same currency as the loan.

Example: 5.6

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

The fee name.

Example: "Renovação de cadastro"

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

The fee code.

Example: "CADASTRO"

fee_charge_typestringrequired

Indicates the type of charge. We return one of the following values:

SINGLE
PER_INSTALLMENT

Enum"SINGLE""PER_INSTALLMENT"

Example: "SINGLE"

fee_chargestringrequired

Billing method, as agreed upon with the institution. We return one of the following values:

MINIMUM
MAXIMUM
FIXED
PERCENTAGE

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

Example: "FIXED"

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

The percentage rate of the fee. Required when fee_charge is set to PERCENTAGE.

Example: 0.062

contracted_chargesArray of objects or null or null

collateralsArray of objects or null or nullrequired

Details regarding any loan collaterals that the individual or business supplied.

typestringrequired

The type of collateral, as defined by the institution.

Example: "OPERACOES_GARANTIDAS_PELO_GOVERNO"

subtypestringrequired

The subtype of the collateral, as defined by the institution.

Example: "CCR_CONVENIO_CREDITOS_RECIPROCOS"

currencystring<= 3 characters^[A-Z]{3}$required

The three-letter currency code (ISO-4217).

Example: "BRL"

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

The total amount of the bill.

Example: 45391.89

balloon_paymentsArray of objects or null or nullrequired

Detailed information regarding any balloon payments for the loan, if applicable.

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

The date that the balloon payment is to be paid, in YYYY-MM-DD format.

Example: "2021-09-06"

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

The three-letter currency code (ISO-4217).

Example: "BRL"

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

The total amount of the balloon payment.

Example: 45391.89

installments_contract_term_frequencystring or nullrequired

The frequency of contracted installment payments, as defined when the contract was first signed. We return one of the following:

DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null

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

Example: "MONTH"

installment_frequencystringrequired

The frequency that the installments are paid. We return one of the following values:

IRREGULAR
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHER

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

Example: "MONTHLY"

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

Additional information regarding the installment_frequency.

Example: "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?...required

The date when the first installment of the loan is to be paid, in YYYY-MM-DD format.

Example: "2020-03-01"

number_of_installments_totalinteger or null(int32)<= 999999999required

The total number of installments required to pay the loan.

Example: 60

number_of_installments_outstandinginteger or null(int32)<= 999999999required

The number of installments left to pay.

Example: 48

number_of_installments_paidinteger or null(int32)<= 999999999required

The number of installments already paid.

Example: 32

number_of_installments_past_dueinteger or null(int32)<= 999required

The number of installments that are overdue.

Example: 2

disbursement_datesArray of strings or null or nullnon-emptyrequired

An array of dates when the loan was disbursed.

Example: ["2021-09-23"]

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

The date that the loan was settled, in YYYY-MM-DD format.

Example: "2021-09-23"

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

The date when the loan contract was signed, in YYYY-MM-DD format.

Example: "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?...required

The date when the loan is expected to be completed, in YYYY-MM-DD format.

Example: "2027-10-01"

contract_remaining_frequencystring or nullrequired

The frequency of the remaining contracted installment payments, as defined when the contract was first signed. We return one of the following:

DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null

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

Example: "MONTH"

contract_remaining_totalinteger or null(int32)<= 999999999required

The total number of installments remaining on the loan.

Example: 20

amortization_schedulestringrequired

The loan amortization schedule.

Example: "SEM_SISTEMA_AMORTIZACAO"

amortization_schedule_infostring or null<= 200 characters[\w\W\s]*required

Additional information regarding the amortization_schedule.

Example: "No need for a schedule."

consignee_idstring or null<= 14 characters^\d{14}$required

The ID of the consignee of the loan.

Example: "60500998000135"

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

The contract number of the loan, as given by the institution.

Example: "1324926521496"

monthly_paymentnumber or null(float)required

Note: This field is not applicable for OF Brazil and will return null.

Example: null

principalnumber or null(float)required

Note: This field is not applicable for OF Brazil and will return null.

Example: null

payment_daystring or nullrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

outstanding_principalnumber or null(float)required

Note: This field is not applicable for OF Brazil and will return null.

Example: null

credit_limitnumber or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

last_period_balancenumber or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

interest_ratenumber or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

limit_daystring or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

cutting_daystring or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

cutting_datestring or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

last_payment_datestring or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

no_interest_paymentnumber or nullDeprecatedrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: null

funds_datastring or nullrequired

Note: This field is not applicable for OF Brazil and will return null.

Example: 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
}

Belvo API Docs (1.219.0)

Introduction

Available Information and Payment Methods

Data Dictionaries

Environments

Sandbox

Production

Response codes

Error handling

Request identifier

Error codes and troubleshooting

Retry policy

50x errors

40x errors

Deprecated fields

OpenAPI: required and nullable fields

Institutions

Links

Widget Access Token

Consents

Owners

Accounts

Account Object (OFDA Brazil)

List accounts

Request

▶️ Usage

🔦 Filtering Responses

📖 Pagination

🚨 Deprecated Fields

Responses

Was this helpful?

Retrieve accounts for a link

Request

Responses

Was this helpful?

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)

Payment Transactions (Brazil)