Investments
Our Investments resource lets you get a comprehensive view of your user's current investment holdings.
With Belvo's Investments resource, you can access information about your user's investment holdings across banking and broker institutions.
Investment Portfolios
A portfolio is a grouping of investment products (called instruments) that your user has purchased. The way portfolios are grouped are institution specific (for example, one institution may group stocks and funds in the same portfolio, while in another they might group these in separate portfolios).
At the moment we only support the following institutions and investment products:
Institution Portfolio Instruments Banco de Brazil Retail (Brazil) FIXED_INCOME
DEPOSIT
Banco Inter Retail (Brazil) FIXED_INCOME
DEPOSIT
Bradesco Retail (Brazil) FIXED_INCOME
,VARIABLE_INCOME
DEPOSIT
,FUND
CaixaBank Retail (Brazil) FIXED_INCOME
,VARIABLE_INCOME
DEPOSIT
,FUND
Itau Retail (Brazil) FIXED_INCOME
,VARIABLE_INCOME
DEPOSIT
,FUND
,STOCKS
Santander Retail (Brazil) FIXED_INCOME
,VARIABLE_INCOME
DEPOSIT
,BOND
,FUND
We offer the following methods when it comes to interacting with portfolios:
Endpoint | Method | Description |
---|---|---|
Retrieve | POST | Retrieve all portfolios (and their instruments) related to a specific link. |
List | GET | List all the portfolios (and their instruments) for all the Links already associated with your Belvo account. |
Resume | PATCH | Resume a portfolio Retrieve session that was paused because an MFA token was required by the institution. |
Detail | GET | Get the details of a specific portfolio. |
Destroy | DELETE | Delete a specific portfolio and all associated instrument transactions from your Belvo account. |
Portfolio types
At present, Belvo returns the following types of portfolios:
Portfolio type | Included instrument types |
---|---|
FIXED_INCOME | BOND , DEPOSIT |
VARIABLE_INCOME | STOCK , FUND , ETF |
OTHER | Reserved for currently unmapped instruments |
Instruments
In the instruments
array of a portfolio, Belvo returns detailed information for all the investment products your user has purchased.
An instrument is an investment product that your user has purchased (for example, bonds, stocks, long-term deposits, or a stake in an investment fund).
We currently define the following instrument types (with examples, per country, of what they include):
Instrument type | 🇧🇷 Brazil |
---|---|
DEPOSIT | CBD, Debenture, LCI, LCA, CRI, CRA, LF |
BOND | Tesouro Direto, including: LTN, LFT, IPCA +, IGPM +, NTN-B, NTN-C, NTN-F |
STOCK | Ações |
FUND | Fundos de Investimentos, Fundos Imobiliarios |
ETF | Fundo de Índice |
Instrument Redemption Conditions
Many instruments have conditions regarding when or how you can redeem the value of the investment product. For example, with DEPOSIT
instruments this can be the date when they can extract their profits (due_date
).
Instrument Fees
An instrument may have fees applied to it for many reasons, depending on the institution and the instrument type. We currently define the following instrument fees (and their mapping, per country):
Instrument fee | 🇧🇷 Brazil |
---|---|
OPERATION_FEE | IOF |
INCOME_FEE | IR/IRRF |
CUSTODY_FEE | Corretora (Itau) |
BROKERAGE_FEE | CBLC |
MANAGEMENT_FEE | Taxa de Administração |
PERFORMANCE_FEE | Taxa de Performance |
BMF_FEE | BMF, BOVESPA |
Updated 8 months ago