Reach new audiences and convert more users by easily and safely connecting to their financial data, understanding their behavior and enabling instant payments with open finance. Through our API, you can access:
Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way.
Through our API, you can access:
You can also use our API to make payments in:
If you woud like the response documentation in Excel or CSV form, please download them from our public GitHub Reposiitory: Belvo Open Finance Data Dictionaries.
Our EXCEL and CSV files are additionally localized into Spanish and Portuguese (Brazil).
Available for:
Use our Sandbox environment to build your integration. We offer dummy data that mimics that of real-world use cases, which means you can test out all the endpoints, use the widget, and implement webhooks - just as you would with real-world data!
All you need to get started with the Sandbox environment is to get your API keys. We really recommend that you start creating your integration in this environment.
Available for:
After you have tested your integration in the Sandbox environment and are ready to go live, you'll need to request access to our Production environment. After you request access, our Sales Team will get in contact with you to schedule a meeting just to ensure your needs are met, and then you'll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally. To prepare for the certification meeting, just follow our Integration checklist.
Once your integration is certified, all you'll need to do is:
sandbox.belvo.com to api.belvo.com.We use the following HTTP status code in the response depending on the success or failure:
| 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. |
Belvo API errors are returned in JSON format. For example, an error might look like this:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "This field is required.",
"code": "required",
"field": "link"
}
]Typically, an error response will have the following parameters:
request_id: a unique ID for the request, you should share it with the Belvo support team for investigations.message: human-readable description of the error.code: a unique code for the error. Check the table below to see how to handle each error code.field (optional): The specific field in the request body that has an issue.When you need help with a specific error, include the request identifier (request_id) in your message to the Belvo support team. This will speed up investigations and get you back up and running in no time at all.
For a full list of errors and how to troubleshoot them, please see our dedicated Error Handling article.
Implement an automated exponential backoff of up to five retries. We recommend using a base interval of three seconds with a factor of two. For example, the first retry should be after three seconds, the second retry after six seconds (2 * 3), the third retry after 12 seconds (2 * 6), the fourth retry after 24 seconds (2 * 12), and the fifth retry after 48 seconds (2 * 24).
You should not retry making requests if you receive a 40x response, as this is a client error.
The only exception is the “Too Many Sessions” error, as it means that your end-user is accessing the account from another browser at the same time. In this case, please implement the same retry policy as with 50x errors.
In our schema, you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.
In our API specification, you'll see that some response parameters will have a required annotation. According to the OpenAPI specification, when a response parameter is marked as required, this means that the response key must be returned. However, the value of that response parameter can be null.
📘 Info
In short, any response parameter marked as required will be returned by our API, but the value can be set to null.
An institution is an entity that Belvo can access information from. It can be a:
You can see a complete list of institutions by either consulting our Institutions article or making a List request to this endpoint.
An owner represents the person who has access to a Link and is the owner of all the accounts inside the Link.
You can use this endpoint in order to get useful information about your client, such as:
An account is the representation of a bank account inside a financial institution. A user can have one or more accounts in an institution.
For example, one user (or link) can have a checking account, several credit cards, and a loan account.
Querying for a user's account information is useful as you can get information regarding:
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/br/investment-transactions/{id}/?fields=string&omit=string'Ok
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp when the data point was collected.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
The institution's internal identification of the investment transaction.
The date on which the transaction was settled, in YYYY-MM-DD format.
📘
VARIABLE_INCOMEFor
VARIABLE_INCOMEinvestments, 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_FUNDFor
INVESTMENT_FUNDinvestments, 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.
The gross value of the transaction.
🚧 Not applicable for
VARIABLE_INCOMEinvestments.
The net value of the transaction.
🚧 Not applicable for
VARIABLE_INCOMEinvestments.
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_INCOMEandINVESTMENT_FUNDinvestments.
The number of units (shares) considered when calculating the price per share or unit for a transaction.
🚧 Only applicable for
VARIABLE_INCOMEinvestments.
The Financial Transaction Tax (Imposto sobre Operações Financeiras (IOF)) applied or withheld during the transaction.
🚧 Not applicable for
VARIABLE_INCOMEinvestments.
The Income Tax (Imposto de Renda (IR)) applied or withheld during the transaction.
🚧 Not applicable for
VARIABLE_INCOMEinvestments.
The transaction type (INFLOW or OUTFLOW) from the investment perspective.
The transaction subtype.
FIXED_INCOME_BANKING: APLICACAO, RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.FIXED_INCOME_CREDIT: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, PRÊMIO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, MULTA, MORA, OUTROS.VARIABLE_INCOME: COMPRA, VENDA, DIVIDENDOS, JCP, ALUGUEIS, TRANSFERENCIA_TITULARIDADE, OUTROS.INVESTMENT_FUND: AMORTIZACAO, TRANSFERENCIA_DE_COTAS, APLICACAO, RESGATE, COME_COTAS, OUTROS.TREASURY_BOND: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.Additional information about the transaction subtype. This field is mandatory when the subtype is OUTROS.
The maximum percentage of the indexer for the contract (Bancaria) or transaction (Credito).
🚧 Only applicable for
FIXED_INCOME_BANKINGandFIXED_INCOME_CREDITinvestments.
The remuneration rate applied to the transaction.
🚧 Only applicable for
FIXED_INCOME_BANKING,FIXED_INCOME_CREDIT, andTREASURY_BONDinvestments.
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_FUNDinvestments.
Details regarding the broker note that is associated with this transaction. This object is only returned for transactions that are associated with a VARIABLE_INCOME investment type.
📘 Info
A broker note (nota de corretagem) is an official document issued by a brokerage detailing the transactions made by an investor on a given day. It includes information on the gross value of all purchases and sales, brokerage fees, clearing and settlement fees, clearing and registration fees, stock exchange asset trade notice fees, stock exchange fees, clearing custody fees, taxes, and income tax withheld at source.
{ "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", "is_tax_exempt": false, "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": { … }, "remuneration": { … }, "classification_details": { … }, "voucher_payment_details": { … }, "debtor_details": { … } }, "internal_identification": "ABCD2126019929279212650822221989319253344", "value_date": "2024-11-18", "gross_value": 60, "net_value": 60, "value": 60, "unit_price": 3, "price_factor": 1, "transaction_tax": 0, "income_tax": 0, "quantity": 20, "type": "INFLOW", "subtype": null, "subtype_additional_info": null, "indexer_percentage": 0, "rate": 0, "exit_fee": 0, "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 } }
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/br/investment-transactions/{id}/'Our employments resource for Brazil lets you get a comprehensive view of your user's current employment history and salary information.
For each user, we return the:
At the moment, the employments resource is available for:
Our employment records resource for Mexico lets you get a comprehensive view of your user’s current social security contributions and employment history.
With Belvo's employment records resource for Mexico, you can access information about your user's current social security contributions and employment history. For the each user, we return the:
At the moment, the employment records resource is available for:
Belvo's Recurring Expenses API allows you to identify a user's regular payments for subscription services, such as Netflix or gym memberships, as well as utility payments, such as electricity or phone bills. We return information for up to 365 days.
📘 Info
The recurring expenses resource is only available for Checking, Savings and Credit Card accounts associated with banking links.
To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.
A payment intent is a single point of access to create payments using any payment method offered by Belvo.
A payment intent captures all payment information (such as the amount to be charged, the description of the payment, the provider, and so on) and guides your customers through the payment flow.
Note: For institutions that require the
username_typein theform_fieldsarray, you must send through this value in your PATCH request.