URL
Need help?
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.
https://developers.belvo.com/_mock/apis/belvoopenapispec/
https://sandbox.belvo.com/
An institution is an entity that Belvo can access information from. It can be a:
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:
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:
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.
The session you want to resume. You need to use the session value that is provided in the 428 Token Required response that you receive after you make your POST request.
The MFA token generated by the institution which is required to continue a session.
The link.id you want to resume. Must be the same link.id as the one you receive in the 428 Token Required response that contains the session ID.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/
https://sandbox.belvo.com/api/incomes/
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (when save_data=false)
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
An array of enriched income stream objects.
Unique ID for the bank account to be verified for income streams.
The type of income used in the calculations.
We return one of the following enum values:
SALARYGOVERNMENTINTERESTRENTRETIREMENTFREELANCEALTERNATIVE_INCOMETRANSFERDEPOSITUNKNOWNHow often the income is received.
We return one of the following enum values:
MONTHLY - For transactions that occur once per month.FORTNIGHTLY - For transactions that occur once every two weeks.WEEKLY - For transactions that occur once per week.IRREGULAR - For transactions that do not occur on a defined frequency pattern.SINGLE - For transactions that occur only once and do not repeat.The average amount of income received from the source over periods_with_income.
The median amount of income received from the source over within a natural month.
The average income transaction amount from the source.
The amount of the most recent income received from the source.
The three-letter currency code of the income. For example:
• 🇧🇷 BRL (Brazilian Real) • 🇨🇴 COP (Colombian Peso) • 🇲🇽 MXN (Mexican Peso)
The description of the most recent income from the stream.
The date when the most recent income from the stream was received, in YYYY-MM-DD format.
The stability of the income based on its amount, with a range from 0 to 1, where 1 represents perfect stability.
Note: For transactions with frequency=SINGLE, this value returns null.
The regularity of the income based in its frequency, with a range from 0 to 1, where 1 represents perfect regularity.
Note: For transactions with frequency=SINGLE, this value returns null.
The income trend during a period of time calculated between last income and first income received, where:
Note: For transactions with frequency=SINGLE, this value returns null.
Number of period units (based on rolling months) used to generate insights and calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with data to perform calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with at least one income available.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of income transactions over the lookback_periods.
The type of source we generate income insights from. We return one of the following enum values:
BANKThe date when the first transaction occurred, in YYYY-MM-DD format.
The date when when the last transaction occurred, in YYYY-MM-DD format.
The best working day of the month to charge the user.
Additional working days that have been identified as good days to charge the user.
Average amount of income received per month across all the accounts for the specific user.
Average amount of regular income (with a frequency of MONTHLY, FORTNIGHTLY, or WEEKLY) received per month for the specific user.
Average amount of irregular income (with a frequency of SINGLE or IRREGULAR) received per month for the specific user.
Average amount of income received per month for the specific user with LOW confidence.
Average amount of income received per month for the specific user with MEDIUM confidence.
Average amount of income received per month for the specific user with HIGH confidence.
Total amount of all income received for the specific user.
Total amount of regular income (with a frequency of MONTHLY, FORTNIGHTLY, WEEKLY) for the specific user.
Total amount of irregular income (with a frequency of SINGLE or IRREGULAR) for the specific user.
Total amount of income for the specific user with LOW confidence.
Total amount of income for the specific user with MEDIUM confidence.
Total amount of income for the specific user with HIGH confidence.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ … ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ … ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 } ]
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.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/{id}/
https://sandbox.belvo.com/api/incomes/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/{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 of when the data point was created in Belvo's database.
An array of enriched income stream objects.
Unique ID for the bank account to be verified for income streams.
The type of income used in the calculations.
We return one of the following enum values:
SALARYGOVERNMENTINTERESTRENTRETIREMENTFREELANCEALTERNATIVE_INCOMETRANSFERDEPOSITUNKNOWNHow often the income is received.
We return one of the following enum values:
MONTHLY - For transactions that occur once per month.FORTNIGHTLY - For transactions that occur once every two weeks.WEEKLY - For transactions that occur once per week.IRREGULAR - For transactions that do not occur on a defined frequency pattern.SINGLE - For transactions that occur only once and do not repeat.The average amount of income received from the source over periods_with_income.
The median amount of income received from the source over within a natural month.
The average income transaction amount from the source.
The amount of the most recent income received from the source.
The three-letter currency code of the income. For example:
• 🇧🇷 BRL (Brazilian Real) • 🇨🇴 COP (Colombian Peso) • 🇲🇽 MXN (Mexican Peso)
The description of the most recent income from the stream.
The date when the most recent income from the stream was received, in YYYY-MM-DD format.
The stability of the income based on its amount, with a range from 0 to 1, where 1 represents perfect stability.
Note: For transactions with frequency=SINGLE, this value returns null.
The regularity of the income based in its frequency, with a range from 0 to 1, where 1 represents perfect regularity.
Note: For transactions with frequency=SINGLE, this value returns null.
The income trend during a period of time calculated between last income and first income received, where:
Note: For transactions with frequency=SINGLE, this value returns null.
Number of period units (based on rolling months) used to generate insights and calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with data to perform calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with at least one income available.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of income transactions over the lookback_periods.
The type of source we generate income insights from. We return one of the following enum values:
BANKThe date when the first transaction occurred, in YYYY-MM-DD format.
The date when when the last transaction occurred, in YYYY-MM-DD format.
The best working day of the month to charge the user.
Additional working days that have been identified as good days to charge the user.
Average amount of income received per month across all the accounts for the specific user.
Average amount of regular income (with a frequency of MONTHLY, FORTNIGHTLY, or WEEKLY) received per month for the specific user.
Average amount of irregular income (with a frequency of SINGLE or IRREGULAR) received per month for the specific user.
Average amount of income received per month for the specific user with LOW confidence.
Average amount of income received per month for the specific user with MEDIUM confidence.
Average amount of income received per month for the specific user with HIGH confidence.
Total amount of all income received for the specific user.
Total amount of regular income (with a frequency of MONTHLY, FORTNIGHTLY, WEEKLY) for the specific user.
Total amount of irregular income (with a frequency of SINGLE or IRREGULAR) for the specific user.
Total amount of income for the specific user with LOW confidence.
Total amount of income for the specific user with MEDIUM confidence.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ { … } ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ 17, 7, 2 ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 }
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/{id}/
https://sandbox.belvo.com/api/incomes/{id}/
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/incomes/{id}/'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.