v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Investments Brazil

Retrieve investments for a link

Retrieve investments for an existing link.

post/api/br/investments/

Query parameters

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

Request body

linkstring uuid required

The link.id you want to retrieve information for.

save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Example request

{
  "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
  "save_data": true
}

Response

Ok (when save_data=false)

idstring uuid

The unique identifier created by Belvo used to reference the current investment.

typestring

The type of investment: Can be either

FIXED_INCOME_BANKING (Renda Fixa Bancária)
FIXED_INCOME_CREDIT (Renda Fixa Crédito)
VARIABLE_INCOME (Renda Variável)
TREASURY_BOND (Tesouro Direto)
INVESTMENT_FUND (Fundos de Investimento)

issuer_id_numberstring nullable

The CNPJ number of the issuing institution. For Investment Funds, this is the CNPJ of the fund.

🚧 Not applicable for TREASURY_BOND investments.

isin_numberstring nullable

The ISO-6166 International Securities Identification Number (ISIN) for the financial instrument.

currencystring

The three-letter currency code (ISO-4217) of the investment. For example, BRL for Brazilian Real.

product_namestring

The name of the investment product.

For FIXED_INCOME_BANKING, this can be: CDB, RDB, LCI, or LCA.
For FIXED_INCOME_CREDIT, this can be: DEBENTURES, CRI, or CRA.
For INVESTMENT_FUND, this will be the name of the fund. For example: CONSTELLATION MASTER FIA
For TREASURY_BOND, this will be the name of the bond. For example: Tesouro Selic 2025.
For VARIABLE_INCOME_INCOME, this will be the name of the stock. For example AAPL.

is_tax_exemptboolean

Indicates if the investment is exempt from taxes.

🚧 Only applicable for FIXED_INCOME_CREDIT investments.

clearing_codestring nullable

The clearing code of the investment.

🚧 Only applicable for FIXED_INCOME_BANKING and FIXED_INCOME_CREDIT.

due_datestring date nullable

The maturity date of the financial instrument.

🚧 Only applicable for FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT, and TREASURY_BOND investments.

issue_datestring date nullable

The date the financial instrument was issued.

🚧 Only applicable for FIXED_INCOME_BANKING and FIXED_INCOME_CREDIT.

purchase_datestring date nullable

The date the financial instrument was purchased.

🚧 Only applicable for FIXED_INCOME_BANKING, FIXED_INCOME_CREDIT, and TREASURY_BOND investments.

grace_period_datestring date nullable

The grace period date of the financial instrument.

🚧 Only applicable for FIXED_INCOME_BANKING and FIXED_INCOME_CREDIT.

issue_unit_pricenumber float nullable

The unit price of the financial instrument at the time of issuance.

🚧 Only applicable for FIXED_INCOME_BANKING and FIXED_INCOME_CREDIT.

Example response

[
  {
    "id": "5359ddc5-31fc-4346-934b-cc24630a8d06",
    "type": "FIXED_INCOME_BANKING",
    "issuer_id_number": "10187609364567",
    "isin_number": "BRCST4CTF001",
    "currency": "BRL",
    "product_name": "CONSTELLATION MASTER FIA",
    "clearing_code": "CDB421GPXXX",
    "due_date": "2022-01-01",
    "issue_date": "2021-01-01",
    "purchase_date": "2021-01-01",
    "grace_period_date": "2021-01-01",
    "issue_unit_price": 1000,
    "balance": {
      "reference_date": "2022-07-21T17:32:00Z",
      "gross_value": 1000,
      "blocked_amount": 100,
      "quantity": 100,
      "gross_unit_price": 10,
      "net_value": 900,
      "withheld_amount": 10,
      "transaction_fee": 5,
      "purchase_unit_price": 10,
      "pre_fixed_rate": 0.05,
      "post_fixed_rate": 0.05,
      "penalty_fee": 10,
      "late_payment_fee": 10,
      "closing_price": 10,
      "unit_price_factor": 1
    },
    "remuneration": {
      "pre_fixed_rate": 0.05,
      "post_fixed_rate": 0.05,
      "rate_type": "LINEAR",
      "rate_periodicity": "MENSAL",
      "calculation_base": "DIAS_CORRIDOS",
      "indexer": "CDI",
      "indexer_additional_info": "IPCA + 5%"
    },
    "classification_details": {
      "category": "ACOES",
      "class": "Ações Livre",
      "subclass": "Ações Livre"
    },
    "voucher_payment_details": {
      "is_voucher_payment": true,
      "periodicity": "MENSAL",
      "periodicity_additional_info": "30/360"
    },
    "debtor_details": {
      "name": "Roberto Marino"
    }
  }
]