v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Investment Transactions Brazil

Retrieve investments for a link

Retrieve investments for an existing link.

post/api/br/investment-transactions/

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.

date_fromstring date

The date from which you want to start getting data for, in YYYY-MM-DD format.

⚠️ The value of date_from cannot be greater than date_to.

date_tostring date

The date you want to stop getting data for, in YYYY-MM-DD format.

⚠️ The value of date_to cannot be greater than today's date (in other words, no future dates).

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",
  "date_from": "2020-08-05",
  "date_to": "2020-10-05",
  "save_data": true
}

Response

Ok (when save_data=false)

idstring uuid

Belvo's unique identifier for the current item.

linkstring uuid nullable

The link.id the data belongs to.

collected_atstring date-time

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

created_atstring date-time

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

internal_identificationstring

The institution's internal identification of the investment transaction.

value_datestring date

The date on which the transaction was settled, in YYYY-MM-DD format.

📘 VARIABLE_INCOME

For VARIABLE_INCOME investments, you will only receive transactions up until the last trading date. For example, if today is 19.11.2024, you will only receive transactions up till 18.11.2024.

📘 INVESTMENT_FUND

For INVESTMENT_FUND investments, this is the date when the transaction (purchase or redemption) is officially processed into fund shares or quotas. For purchases, this is the date the investor’s money is applied to acquire fund shares. For redemptions, this is the date when the fund shares are officially converted back into cash.

gross_valuenumber float

The gross value of the transaction.

🚧 Not applicable for VARIABLE_INCOME investments.

net_valuenumber float

The net value of the transaction.

🚧 Not applicable for VARIABLE_INCOME investments.

valuenumber float

The value of the transaction.

For VARIABLE_INCOME investments, this is the value of the trade executed by the client. If the client buys or sells stocks, this field indicates the total value of the trade (for example, the price per share × quantity).

For INVESTMENT_FUND investments, this is the value requested by the client for a fund transaction.

🚧 Only applicable for VARIABLE_INCOME and INVESTMENT_FUND investments.

unit_pricenumber float

The price for an individual unit or quota.

price_factornumber float

The number of units (shares) considered when calculating the price per share or unit for a transaction.

🚧 Only applicable for VARIABLE_INCOME investments.

transaction_taxnumber float

The Financial Transaction Tax (Imposto sobre Operações Financeiras (IOF)) applied or withheld during the transaction.

🚧 Not applicable for VARIABLE_INCOME investments.

income_taxnumber float

The Income Tax (Imposto de Renda (IR)) applied or withheld during the transaction.

🚧 Not applicable for VARIABLE_INCOME investments.

quantitynumber float

The number of units, quotas, or assets involved in a transaction.

type'INFLOW' | 'OUTFLOW' | 'null'

The transaction type (INFLOW or OUTFLOW) from the investment perspective.

subtypestring

The transaction subtype.

For FIXED_INCOME_BANKING: APLICACAO, RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.
For FIXED_INCOME_CREDIT: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, PRÊMIO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, MULTA, MORA, OUTROS.
For VARIABLE_INCOME: COMPRA, VENDA, DIVIDENDOS, JCP, ALUGUEIS, TRANSFERENCIA_TITULARIDADE, OUTROS.
For INVESTMENT_FUND: AMORTIZACAO, TRANSFERENCIA_DE_COTAS, APLICACAO, RESGATE, COME_COTAS, OUTROS.
For TREASURY_BOND: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.

subtype_additional_infostring

Additional information about the transaction subtype. This field is mandatory when the subtype is OUTROS.

indexer_percentagenumber float

The maximum percentage of the indexer for the contract (Bancaria) or transaction (Credito).

🚧 Only applicable for FIXED_INCOME_BANKING and FIXED_INCOME_CREDIT investments.

ratenumber float

The remuneration rate applied to the transaction.

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

exit_feenumber float

The exit fee applied to the Investment Fund (Fundos de Investimento) transaction. This fee is charged when a client redeems or exits the fund.

🚧 Only applicable for INVESTMENT_FUND investments.

Example response

[
  {
    "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
    "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "investment": {
      "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"
      }
    },
    "internal_identification": "ABCD2126019929279212650822221989319253344",
    "value_date": "2024-11-18",
    "gross_value": 60,
    "net_value": 60,
    "value": 60,
    "unit_price": 3,
    "price_factor": 1,
    "quantity": 20,
    "type": "INFLOW",
    "broker_note_details": {
      "broker_note_number": "1854009930314350",
      "gross_value": 1000,
      "brokerage_fee": 10,
      "clearing_settlement_fee": 2.5,
      "clearing_registration_fee": 1,
      "stock_exchange_asset_trade_notice_fee": 0.5,
      "stock_exchange_fee": 3,
      "clearing_custody_fee": 1.5,
      "taxes": 10,
      "income_tax": 5,
      "net_value": 980
    }
  }
]