With Belvo's Open Finance Data Aggregation (OFDA) product for Brazil, you can retrieve the account information for a link.

For each account that the user has, you receive:

Core information about the account (category, type, number, currency).
Balance and overdraft information
In the case that the account is a credit card account, detailed information regarding the credit limits and cards.
In the case that the account is a loan-type account, detailed information regarding the loan amount, repayment schedule, interest rates, and more.

Core information

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2019-09-27T13:01:41.941Z",
  "last_accessed_at": "2021-03-09T10:28:40.000Z",
  "category": "CHECKING_ACCOUNT",
  "balance_type": "ASSET",
  "currency": "BRL",
  "name": null,
  "type": "CONTA_DEPOSITO_A_VISTA",
  "subtype": "INDIVIDUAL",
  "number": "11188222",
  "agency": "6272",
  "check_digit": "4",
  "public_identification_name": "AGENCY/NUMBER",
  "public_identification_value": "6272/11188222",
  "internal_identification": "92792126019929279212650822221989319252576",
  "institution": {
    "name": "ofmockbank_br_retail",
    "type": "bank"
  },
  "balance": {}, // See the specific balance section below
  "overdraft": {}, // See the specific overdraft section below
  "credit_data": {}, // See the specific credit_data section below
  "loan_data": {} // See the specific loan_data section below
}

Parameter	Type	Description	Example
id	string	Belvo's unique identifier for the current item.	0d3ffb69-f83b-456e-ad8e-208d0998d71d
link	string	The `link.id` the data belongs to.	30cb4806-6e00-48a4-91c9-ca55968576c8
created_at	string (date-time)	The ISO-8601 timestamp of when the data point was created in Belvo's database.	2022-02-09T08:45:50.406032Z
collected_at	string (date-time)	The ISO-8601 timestamp when the data point was collected.	2019-09-27T13:01:41.941Z
last_accessed_at	string (date-time)	The ISO-8601 timestamp when Belvo last accessed the account.	2021-03-09T10:28:40.000Z
category	string	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`, or `UNCATEGORIZED`	CHECKING_ACCOUNT
type	string	The account type, as designated by the institution. > Non-nullable: A value must be returned by Brazil's open finance network.	CONTA_DEPOSITO_A_VISTA
subtype	string	The account subtype, as designated by the institution. > Non-nullable: A value must be returned by Brazil's open finance network.	INDIVIDUAL
name	string	The account name, as given by the institution.	CONTA_DEPOSITO_A_VISTA
number	string	The account number, as designated by the institution.	4057068115181
agency	string	The branch code where the product was opened.	6272
check_digit	string	The check digit of the product's number, if applicable.	7
clearing_code	string	The clearing code for the account.	1
currency	string	The three-letter currency code (ISO-4217). > Non-nullable: A value must be returned by Brazil's open finance network if the `balances` field is available.	BRL
public_identification_name	string	The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be `AGENCY/ACCOUNT`.	AGENCY/ACCOUNT
public_identification_vale	string	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"	6272/24550245
internal_identification	string	The institution's internal identification for the account. > Non-nullable: A value must be returned by Brazil's open finance network if the `balances` field is available.	92792126019929279212650822221989319252576
balance_type	string	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.	ASSET
balance	object	Details regarding the current and available balances for the account.	See the balance section for details.
overdraft	object	Details regarding any overdraft limits the user has with the institution for this account.	See the overdraft section for details.
credit_data	object	Details regarding the credit cards associated with this account.	See the credit_data section for details.
loan_data	object	The loan options associated with this account.	See the loan_data section for details.

balance

In the balance object, we provide you with the information regarding the account's balances.

{
  "balance": {
    "current": 5874.13,
    "available": 5621.12,
    "blocked": 60.32,
    "automatically_invested": 131.5
  }
}

Parameter	Type	Description	Example
current	number	The current balance is calculated differently according to the type of account.*	5874.13
available	number	The balance that the account owner can use. *	5621.12
blocked	number	The amount that is currently blocked due to pending transactions. > Non-nullable: A value must be returned by Brazil's open finance network if the `balances` field is available.	60.32
automatically_invested	number	The amount that is automatically invested (as agreed upon with the institution). > Non-nullable: A value must be returned by Brazil's open finance network if the `balances` field is available.	131.5

* Please note that for the current and available fields, the values returned for checking, credit card, or loan accounts depend on the account type:

Parameter	Checking or Savings	Credit Cards	Loan Account
current	The user's account balances as of the `collected_at` timestamp.	The amount the user has spent in the current card billing period.	The amount remaining to pay on the users's loan.
available	The available balance may be different to the `current` balance due to pending transactions.	The credit amount the user still has available for the current period.	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`.

overdraft

In the overdraft object, you can see what limits have been agreed with the bank (arranged), how much the user has already used (used), and whether or not the user has gone over their limit without agreeing with the bank (unarranged).

{
  "overdraft": {
    "arranged": 5000.5,
    "used": 1000.5,
    "unarranged": 300.1
  }
}

Parameter	Type	Description	Example
arranged	number	The agreed upon overdraft limit between the account holder and the institution. > Non-nullable: A value must be returned by Brazil's open finance network if the `overdraft` field is available.	5000.5
used	number	The overdraft value used. > Non-nullable: A value must be returned by Brazil's open finance network if the `overdraft` field is available.	1000.5
unarranged	number	The overdraft used that was not arranged between the account holder and the institution. > Non-nullable: A value must be returned by Brazil's open finance network if the `overdraft` field is available.	300.1

credit_data

Only applicable for credit card accounts.

In the credit_data object, we provide you with the details of the credit card account, including:

detailed information regarding the type of limit the credit card has (limits)
the network that the card belongs to (network and network_additional_info)
whether or not there are multiple cards associated with the credit card account (cards)

{
  "credit_data": {
    "credit_limit": 192000.9,
    "cutting_date": "2019-12-11",
    "minimum_payment": 2400.3,
    "network": "MASTERCARD",
    "network_additional_info": "AURA CARD",
    "limits": [
      {
        "identification_number": "4453",
        "credit_limit": 1000.04,
        "used_amount": 400.04,
        "available_amount": 600,
        "is_limit_flexible": false,
        "type": "TOTAL_LIMIT",
        "consolidation_type": "INDIVIDUAL",
        "line_name": "CREDITO_A_VISTA",
        "line_name_additional_info": "Informações adicionais e complementares"
      }
    ],
    "cards": [
      {
        "is_multiple": false,
        "identification_number": "4453"
      }
    ]
  }
}

Parameter	Type	Description	Example
credit_limit	number	The upper credit limit of the card. > Non-nullable: A value must be returned by Brazil's open finance network.	192000.9
cutting_date	string (date)	The date when the credit card's bill is due.	2019-12-11
minimum_payment	number	The minimum amount that the account owner needs to pay in the current credit period.	2400.3
network	string	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`, or `OTHER`. > Non-nullable: A value must be returned by Brazil's open finance network.	VISA
network_additional_info	string	Additional information about the credit card network.	AURA CARD
limits	array of objects	Details regarding the credit limits for each credit card associated with the account.	See the limits section for details.
cards	array of objects	Details regarding the cards associated with the account.	See the cards section for details.

limits

For each card associated with the account, you receive a separate limits object detailing the credit limits and usage for the given card.

{
  "credit_data": {
    "limits": [
      {
        "identification_number": "4453",
        "credit_limit": 1000.04,
        "used_amount": 400.04,
        "available_amount": 600,
        "is_limit_flexible": false,
        "type": "TOTAL_LIMIT",
        "consolidation_type": "INDIVIDUAL",
        "line_name": "CREDITO_A_VISTA",
        "line_name_additional_info": "Informações adicionais e complementares"
      }
    ]
  }
}

Parameter	Type	Description	Example
identification_number	string	The credit card number. Note: Often, this is just the last four digit of the credit card. > Non-nullable: A value must be returned by Brazil's open finance network.	4453
credit_limit	number	The limit of the credit card.	1000.04
used_amount	number	The amount used.	400.04
available_amount	number	The amount still available. > Non-nullable: A value must be returned by Brazil's open finance network.	600
is_limit_flexible	boolean	Boolean to indicate if the `credit_limit` is flexible. > Non-nullable: A value must be returned by Brazil's open finance network.	false
type	string	The type of limit. We return one of the following values: `TOTAL_LIMIT` or `MODAL_LIMIT`. > Non-nullable: A value must be returned by Brazil's open finance network.	TOTAL_LIMIT
consolidation_type	string	Indicates whether or not the credit limit is consolidated or individual. > Non-nullable: A value must be returned by Brazil's open finance network.	CONSOLIDADO
line_name	string	The credit limit line name.	CREDITO_A_VISTA
line_name_additional_info	string	Additional information about the line name.	Informações adicionais e complementares

cards

For each credit card associated with the account, you receive a cards object detailing the the identification number of the card.

{
  "credit_data": {
    "cards": [
      {
        "is_multiple": false,
        "identification_number": "4453"
      }
    ]
  }
}

Parameter	Type	Description	Example
is_multiple	boolean	Boolean to indicate if this account has multiple credit cards. > Non-nullable: A value must be returned by Brazil's open finance network.	false
identification_number	string	The credit card number. Note: Often, this is just the last four digit of the credit card. > Non-nullable: A value must be returned by Brazil's open finance network.	4453

loan_data

In the loan_data object, we provide you with the details of the loan account, including:

The type of loan (loan_type)
The start and end dates of the loan (contract_start_date and contract_end_date)
A detailed breakdown of the interest rates applied to the loan (interest_rates.interest_rate_data)
The collateral provided for the loan (collaterals)
Whether any balloon payments have been made (balloon_payments)

{
  "loan_data": {
    "loan_type": "HOME_EQUITY",
    "loan_code": "92792126019929279212650822221989319252576",
    "contract_number": "1324926521496",
    "contract_amount": 202000,
    "total_effective_cost": 209000,
    "outstanding_balance": 182000,

    "contract_start_date": "2020-03-01",
    "disbursement_dates": ["2021-09-23"],
    "settlement_date": "2021-09-23",
    "contract_end_date": "2027-10-01",

    "installments_contract_term_frequency": "MONTH",
    "installment_frequency": "MONTHLY",
    "installment_frequency_info": "Sem informações adicionais",
    "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,
    "contract_remaining_frequency": "MONTH",
    "contract_remaining_total": 20,
    "amortization_schedule": "SEM_SISTEMA_AMORTIZACAO",
    "amortization_schedule_info": "Sem informações adicionais",
    "consignee_id": "60500998000135",
    "interest_rates": [
      {
        "name": "NOMINAL",
        "type": "MONTHLY",
        "value": 7.85,
        "interest_rate_data":
          {
            "tax_type": "NOMINAL",
            "rate_type": "SIMPLE",
            "type": "MONTHLY",
            "calculation_base": "30/360",
            "reference_index_type": "FLOATING",
            "reference_index_subtype": "TR_TBF",
            "reference_index_info": "Informações adicionais sobre o TJLP",
            "pre_fixed_rate": 0.062,
            "post_fixed_rate": 0.062,
            "additional_info": "Informações adicionais sobre a taxa"
          }
      }
    ],
    "fees": [
      {
        "name": "Renovação de cadastro",
        "code": "CADASTRO",
        "fee_charge_type": "SINGLE",
        "fee_charge": "FIXED",
        "value": 5.6,
        "rate": 0.062
      }
    ],
    "contracted_charges": [
      {
        "type": "LATE_PAYMENT_INTEREST_FEE",
        "info": "Late fee",
        "rate": 0.062
      }
    ],
    "collaterals": [
      {
        "type": "HIPOTECA",
        "subtype": "IMOVEIS_RESIDENCIAIS",
        "currency": "BRL",
        "amount": 45391.89
      }
    ],
    "balloon_payments": [
      {
        "due_date": "2021-09-06",
        "currency": "BRL",
        "amount": 45391.89
      }
    ],
  }
}

Parameter	Type	Description	Example
loan_type	string	The type of the loan, according to the institution. > Non-nullable: A value must be returned by Brazil's open finance network.	HOME_EQUITY
loan_code	string	The country-specific standardized contract number. > Non-nullable: A value must be returned by Brazil's open finance network.	92792126019929279212650822221989319252576
contract_number	string	The contract number of the loan, as given by the institution.	1324926521496
contract_amount	number	The initial total loan amount when the contract was signed, calculated by the institution. This amount includes the principal + interest + taxes + fees.	202000
total_effective_cost	number	The initial total effective cost of the loan.	209000
outstanding_balance	number	The amount remaining to pay in total, including interest.	182000
contract_start_date	string (date)	The date when the loan contract was signed, in `YYYY-MM-DD` format. > Non-nullable: A value must be returned by Brazil's open finance network.	2020-03-01
disbursement_dates	array of strings	An array of dates when the loan was disbursed. Each date is in `YYYY-MM-DD` format.	["2021-09-23"]
settlement_date	string (date)	The date that the loan was settled, in `YYYY-MM-DD` format.	2021-09-23
contract_end_date	string (date)	The date when the loan is expected to be completed, in `YYYY-MM-DD` format.	2027-10-01
installments_contract_term_frequency	string	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`, or `null`.	MONTH
installment_frequency	string	The frequency that the installments are paid. We return one of the following values: `IRREGULAR`, `WEEKLY`, `FORTNIGHTLY`, `MONTHLY`, `BIMONTHLY`, `QUARTERLY`, `BIANNUALLY`, `ANNUALLY`, or `OTHER`. > Non-nullable: A value must be returned by Brazil's open finance network.	MONTHLY
installment_frequency_info	string	Additional information regarding the `installment_frequency`.	Sem informações adicionais
first_installment_due_date	string (date)	The date when the first installment of the loan is to be paid, in `YYYY-MM-DD` format.	2020-03-01
number_of_installments_total	integer	The total number of installments required to pay the loan.	60
number_of_installments_outstanding	integer	The number of installments left to pay.	48
number_of_installments_paid	integer	The number of installments already paid.	32
number_of_installments_past_due	integer	The number of installments that are overdue.	2
contract_remaining_frequency	string	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`, or `null`.	MONTH
contract_remaining_total		The total number of installments remaining on the loan.	20
amortization_schedule	string	The loan amortization schedule. > Non-nullable: A value must be returned by Brazil's open finance network.	SEM_SISTEMA_AMORTIZACAO
amortization_schedule_info	string	Additional information regarding the `amortization_schedule`.	Sem informações adicionais
consignee_id	string	The ID of the consignee of the loan.	60500998000135
interest_rates	array of objects	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. > Non-nullable: A value must be returned by Brazil's open finance network.	See the interest_rates section for details.
fees	array of objects	Breakdown of the fees applied to the loan.	See the fees section for details.
contracted_charges	array of objects	Breakdown of the charges applied to the loan.	See the contracted_charges section for details.
collaterals	array of objects	Details regarding any loan collaterals that the individual or business supplied.	See the collaterals section for details.
balloon_payments	array of objects	Detailed information regarding any balloon payments for the loan, if applicable.	See the balloon_payments section for details.

interest_rates

In the interest_rates array we provide you information regarding the interest rates of the loan. For each interest rate applied to the load, you receive a separate object.

{
  "loan_data": {
    "interest_rates": [
      {
        "name": "NOMINAL",
        "type": "MONTHLY",
        "value": 7.85,
        "interest_rate_data":
          {
            "tax_type": "NOMINAL",
            "rate_type": "SIMPLE",
            "type": "MONTHLY",
            "calculation_base": "30/360",
            "reference_index_type": "FLOATING",
            "reference_index_subtype": "TR_TBF",
            "reference_index_info": "Informações adicionais sobre o TJLP",
            "pre_fixed_rate": 0.062,
            "post_fixed_rate": 0.062,
            "additional_info": "Informações adicionais sobre a taxa"
          }
      }
    ]
  }
}

However, we highly recommend that you use the interest_rate_data array within the interest_rates object as it contained more detailed information regarding the loan.

Parameter	Type	Description	Example
name	string	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.	NOMINAL
type	string	The period that the interest is applied to the loan. > Non-nullable: A value must be returned by Brazil's open finance network.	MONTHLY
value	number	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_rate`parameter.	7.85
interest_rate_data	objects	Detailed information regarding the interest rate.	See the interest_rate_data section.

interest_rate_data

The interest_rate_data object contains detailed information regarding each interest rate applied to the loan. We highly recommend using the data within this field as it contains more specific information regarding each interest rate.

Parameter	Type	Description	Example
tax_type	string	The type of interest rate tax. We return one of the following values: `NOMINAL` or `EFFECTIVE`. > Non-nullable: A value must be returned by Brazil's open finance network.	NOMINAL
rate_type	string	The type of interest rate. We return one of the following values: `SIMPLE`, or `COMPOUND`. > Non-nullable: A value must be returned by Brazil's open finance network.	SIMPLE
type	string	The period that the interest is applied to the loan. > Non-nullable: A value must be returned by Brazil's open finance network.	MONTHLY
calculation_base	string	The base calculation for the interest rate. > Non-nullable: A value must be returned by Brazil's open finance network.	21/252
reference_index_type	string	The reference index rate. We return one of the following values: `WITHOUT_INDEX_TYPE`, `PRE_FIXED`, `POST_FIXED`, `FLOATING`, `INDEXED_PRICE`, `RURAL_CREDIT`, or `OTHER_INDEX`. > Non-nullable: A value must be returned by Brazil's open finance network.	PRE_FIXED
reference_index_subtype	string	The subtype of the reference index rate.	TJLP
reference_index_info	string	Additional information regarding the reference index rate.	Informações adicionais sobre o TJLP
pre_fixed_rate	number	The pre-fixed percentage rate of the interest rate. > Non-nullable: A value must be returned by Brazil's open finance network.	0.6
post_fixed_rate	number	The post-fixed percentage rate of the interest rate. > Non-nullable: A value must be returned by Brazil's open finance network.	0.55
additional_info	string	Additional information regarding the interest rate.	Informações adicionais sobre a taxa

fees

In the fees array, we provide you detailed information regarding each fee applied to the loan.

{
  "loan_data": {
    "fees": [
      {
        "name": "Renovação de cadastro",
        "code": "CADASTRO",
        "fee_charge_type": "SINGLE",
        "fee_charge": "FIXED",
        "value": 5.6,
        "rate": 0.062
      }
    ]
  }
}

Parameter	Type	Description	Example
name	string	The fee name. > Non-nullable: A value must be returned by Brazil's open finance network if the `fees` field is available.	Renovação de cadastro
code	string	The fee code. > Non-nullable: A value must be returned by Brazil's open finance network if the `fees` field is available.	CADASTRO
fee_charge_type	string	Indicates the type of charge. We return one of the following values: `SINGLE` or `PER_INSTALLMENT`. > Non-nullable: A value must be returned by Brazil's open finance network if the `fees` field is available.	SINGLE
fee_charge	string	Billing method, as agreed upon with the institution. We return one of the following values: `MINIMUM`, `MAXIMUM`, `FIXED`, or `PERCENTAGE`. > Non-nullable: A value must be returned by Brazil's open finance network if the `fees` field is available.	PERCENTAGE
value	number	The total value of the fee. Same currency as the loan.	5.6
rate	number	The percentage rate of the fee. Required when `fee_charge` is set to `PERCENTAGE`.	0.062

contracted_charges

In the contracted_charges array. we provide you with detailed information regarding all the charges that the loan has incurred.

{
  "loan_data": {
    "contracted_charges": [
      {
        "type": "LATE_PAYMENT_INTEREST_FEE",
        "info": "Late fee",
        "rate": 0.062
      }
    ]
  }
}

Parameter	Type	Description	Example
type	string	The type of contracted charge. We return one of the following values: `LATE_PAYMENT_INTEREST_FEE`, `LATE_PAYMENT_PENALTY_FEE`, `DEFAULT_INTEREST_FEE`, `LOAN_CONTRACT_TAX`, `LATE_PAYMENT_TAX`, `NO_CHARGE`, or `OTHER`. > Non-nullable: A value must be returned by Brazil's open finance network if the `contracted_charges` field is available.	LATE_PAYMENT_INTEREST_FEE
info	string	Additional information regarding the contracted charge.	Informações adicionais sobre encargos.
rate	number	The percentage rate of the charge, calculated based on the amount of the loan.	0.07

collaterals

In the collaterals array, we provide you with detailed information regarding any collateral that was provided for the loan.

{
  "loan_data": {
    "collaterals": [
      {
        "type": "HIPOTECA",
        "subtype": "IMOVEIS_RESIDENCIAIS",
        "currency": "BRL",
        "amount": 45391.89
      }
    ]
  }
}

Parameter	Type	Description	Example
type	string	The type of collateral, as defined by the institution. > Non-nullable: A value must be returned by Brazil's open finance network if the `collaterals` field is available.	HIPOTECA
subtype	string	The subtype of the collateral, as defined by the institution. > Non-nullable: A value must be returned by Brazil's open finance network if the `collaterals` field is available.	IMOVEIS_RESIDENCIAIS
currency	string	The three-letter currency code (ISO-4217). > Non-nullable: A value must be returned by Brazil's open finance network if the `collaterals` field is available.	BRL
amount	number	The total amount of the bill. > Non-nullable: A value must be returned by Brazil's open finance network if the `collaterals` field is available.	45391.89

balloon_payments

In the balloon_payments array, we provide you with detailed information regarding any balloon payments for the loan, if applicable.

{
  "loan_data": {
    "balloon_payments": [
      {
        "due_date": "2021-09-06",
        "currency": "BRL",
        "amount": 45391.89
      }
    ]
  }
}

Parameter	Type	Description	Example
due_date	string (date)	The date that the balloon payment is to be paid, in `YYYY-MM-DD` format.	2021-09-06
currency	string	The three-letter currency code (ISO-4217).	BRL
amount	number	The total amount of the balloon payment.	1000.037