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:
With the List Accounts method, you can:
link.id (using the link query parameter).account.id (using the id query parameter).Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our Filtering responses article.
This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article.
This resource may return deprecated fields. In the response documentation 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.
The link.id you want to filter by.
ℹ️ We highly recommend adding the link.id filter in order to improve your performance.
Indicates how many results to return per page. By default we return 100 results per page.
ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).
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.
Return results only for these link.ids.
Return accounts that have a balance.available matching exactly this value.
Return accounts that have a balance.available less than this value.
Return accounts that have a balance.available less than or equal to this value.
Return accounts that have a balance.available greater than this value.
Return accounts that have a balance.available greater than or equal to this value.
Return accounts that have a balance.available within a range of two values.
Return accounts that have a balance.current matching exactly this value.
Return accounts that have a balance.current less than this value.
Return accounts that have a balance.available less than or equal to this value.
Return accounts that have a balance.current greater than this value.
Return accounts that have a balance.available greater than or equal to this value.
Return accounts that have a balance.current within a range of two values.
Return accounts only for the given category (for example, CHECKING_ACCOUNT and SAVINGS_ACCOUNT).
Return accounts only for the given categories (for example, CHECKING_ACCOUNT and SAVINGS_ACCOUNT).
Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).
Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format).
Return results that hold finances or balances in only this three-letter currency code.
Return results that have funds or balances in one of these three-letter currency codes.
Return information only for this resource id.
Return information for these resource ids.
Return results only for this institution (use the Belvo-designated name, such as planet_mx_employment).
Return results only for these institutions (use the Belvo-designated names, such as ofmockbank_br_retail and planet_mx_employment).
Return accounts with exactly this internal (specified by the institution) name.
Return accounts partially matching this internal name (specified by the institution).
Return information only for this account number (as specified by the institution).
Return information for these account numbers (as specified by the institution).
Return information only for this type of account ID. For example, CLABE accounts.
Return information only for this account ID. For example, the account number for a CLABE account.
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/accounts/?balance__available=4000.02&balance__available__gt=2000.02&balance__available__gte=1999.02&balance__available__lt=6000.02&balance__available__lte=5999.02&balance__available__range=4350.02&balance__current=4000.02&balance__current__gt=2000.02&balance__current__gte=1999.02&balance__current__lt=6000.02&balance__current__lte=5999.02&balance__current__range=4350.02&category=CREDIT_ACCOUNT&category__in=SAVINGS_ACCOUNT&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03¤cy=BRA¤cy__in=BRA&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&institution=planet_mx_retail&institution__in=planet_mx_retail&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&name=Cuenta%20Perfiles-%20M.N.%20-%20MXN-666&name__icontains=Perfiles&number=4057068115181&number__in=4057068115181&omit=string&page=1&page_size=100&public_identification_name=CLABE&public_identification_value=150194683119900273&type=Cuentas%20de%20efectivo'Ok
The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).
The URL to the previous page of results. If there is no previous page, the value is null.
{ "count": 130, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ { … } ] }
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 link.id you want to retrieve information for.
The MFA token generated by the institution which is required to continue a session.
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/accounts/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"token": "1234ab",
"save_data": true
}'Ok (when save_data=false)
Belvo's unique identifier for the current item.
The link.id the data belongs to.
Details regarding the institution.
The name of the institution, as designated by Belvo.
Please see our Institutions DevPortal article for a detailed list of institution names.
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 ISO-8601 timestamp of Belvo's most recent successful access to the institution for the given link.
The type of account. We return one of the following enum values:
ADVANCE_DEPOSIT_ACCOUNTCHECKING_ACCOUNTCREDIT_CARDFINANCING_ACCOUNTINVESTMENT_ACCOUNTINVOICE_FINANCING_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDIndicates whether this account is either an ASSET or a LIABILITY. You can consider the balance of an ASSET as being positive, while the balance of a LIABILITY as negative.
The account type, as designated by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The account subtype, as designated by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The account name, as given by the institution.
The account number, as designated by the institution.
The branch code where the product was opened.
The check digit of the product's number, if applicable.
Details regarding the current and available balances for the account.
The current balance is calculated differently according to the type of account.
The user's account balance at the collected_at timestamp.
The amount the user has spent in the current card billing period (see credit_data.cutting_date for information on when the current billing period finishes).
The amount remaining to pay on the users's loan.
The balance that the account owner can use.
The available balance may be different to the current balance due to pending transactions.
The credit amount the user still has available for the current period. The amount is calculated as credit_data.credit_limit minus balance.current.
The present value required to pay off the loan, as provided by the institution.
Note: If the institution does not provide this value, we return null.
The amount that is currently blocked due to pending transactions.
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be AGENCY/ACCOUNT.
The value for the public_identification_name.
For 🇧🇷 OFDA Brazilian savings and checking accounts, this field will be the agency and bank account number, separated by a slash. For example: 0444/45722-0.
For 🇧🇷 OFDA Brazilian credit card accounts, we will return a string of concatenated credit card numbers associated with the account. For example: "8763,9076,5522"
The institution's internal identification for the account.
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
Details regarding the credit cards associated with this account.
The ISO-8601 timestamp when the data point was collected.
The upper credit limit of the card.
Non-nullable: A value must be returned by Brazil's open finance network.
The date when the credit card's bill is due.
The minimum amount that the account owner needs to pay in the current credit period.
The credit network that the card is associated with. We return one of the following values:
VISAMASTERCARDAMERICAN_EXPRESSDINERS_CLUBHIPERCARDBANDEIRA_PROPRIACHEQUE_ELETRONICOELOOTHERNon-nullable: A value must be returned by Brazil's open finance network.
Additional information about the credit card network.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
The loan options associated with this account.
The ISO-8601 timestamp when the data point was collected.
The country-specific standardized contract number.
Non-nullable: A value must be returned by Brazil's open finance network.
The initial total loan amount when the contract was signed, calculated by the institution. This amount includes the principal + interest + taxes + fees.
The initial total effective cost of the loan.
The type of the loan, according to the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The amount remaining to pay in total, including interest.
Breakdown of the interest applied to the loan. With OF Brazil, we highly recommend using the information in interest_rate_data for in-depth information.
Non-nullable: A value must be returned by Brazil's open finance network.
The name of the type of interest rate applied to the loan.
Note: For OFDA Brazil, we recommend you use the interest_date_data.tax_type parameter.
The period that the interest is applied to the loan.
Non-nullable: A value must be returned by Brazil's open finance network.
The interest rate (in percent or currency value).
Note: For OFDA Brazil, we recommend you use the interest_date_data.pre_fixed_rate and interest_date_data.post_fixed_rateparameter.
Detailed information regarding the interest rate.
The type of interest rate tax. We return one of the following values:
NOMINALEFFECTIVENon-nullable: A value must be returned by Brazil's open finance network.
The type of interest rate. We return one of the following values:
SIMPLECOMPOUNDNon-nullable: A value must be returned by Brazil's open finance network.
The period that the interest is applied to the loan.
Non-nullable: A value must be returned by Brazil's open finance network.
The base calculation for the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
The reference index rate. We return one of the following values:
WITHOUT_INDEX_TYPEPRE_FIXEDPOST_FIXEDFLOATINGINDEXED_PRICERURAL_CREDITOTHER_INDEXNon-nullable: A value must be returned by Brazil's open finance network.
The subtype of the reference index rate.
Additional information regarding the reference index rate.
The pre-fixed percentage rate of the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
The post-fixed percentage rate of the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
Breakdown of the fees applied to the loan.
Note: This field is not applicable for OF Brazil and will return null.
The total value of the fee. Same currency as the loan.
The fee name.
Non-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
The fee code.
Non-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Indicates the type of charge. We return one of the following values:
SINGLEPER_INSTALLMENTNon-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Billing method, as agreed upon with the institution. We return one of the following values:
MINIMUMMAXIMUMFIXEDPERCENTAGENon-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Details regarding any loan collaterals that the individual or business supplied.
The type of collateral, as defined by the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
The subtype of the collateral, as defined by the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
Detailed information regarding any balloon payments for the loan, if applicable.
The frequency of contracted installment payments, as defined when the contract was first signed. We return one of the following:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnullThe frequency that the installments are paid. We return one of the following values:
IRREGULARWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYBIANNUALLYANNUALLYOTHERNon-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the installment_frequency.
The date when the first installment of the loan is to be paid, in YYYY-MM-DD format.
The total number of installments required to pay the loan.
The number of installments left to pay.
The number of installments already paid.
The number of installments that are overdue.
An array of dates when the loan was disbursed.
The date that the loan was settled, in YYYY-MM-DD format.
The date when the loan contract was signed, in YYYY-MM-DD format.
Non-nullable: A value must be returned by Brazil's open finance network.
The date when the loan is expected to be completed, in YYYY-MM-DD format.
The frequency of the remaining contracted installment payments, as defined when the contract was first signed. We return one of the following:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnullThe total number of installments remaining on the loan.
The loan amortization schedule.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the amortization_schedule.
The ID of the consignee of the loan.
The contract number of the loan, as given by the institution.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Example of an checking account (OFDA Brazil).
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "institution": { … }, "collected_at": "2019-09-27T13:01:41.941Z", "created_at": "2022-02-09T08:45:50.406032Z", "last_accessed_at": "2021-03-09T10:28:40.000Z", "category": "CHECKING_ACCOUNT", "balance_type": "ASSET", "overdraft": { … }, "type": "CONTA_DEPOSITO_A_VISTA", "subtype": "INDIVIDUAL", "name": null, "number": "11188222", "agency": "6272", "check_digit": "4", "balance": { … }, "currency": "BRL", "public_identification_name": "AGENCY/NUMBER", "public_identification_value": "6272/11188222", "internal_identification": "92792126019929279212650822221989319252576", "credit_data": null, "loan_data": null, "funds_data": null } ]
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.
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/accounts/?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.
Details regarding the institution.
The name of the institution, as designated by Belvo.
Please see our Institutions DevPortal article for a detailed list of institution names.
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 ISO-8601 timestamp of Belvo's most recent successful access to the institution for the given link.
The type of account. We return one of the following enum values:
ADVANCE_DEPOSIT_ACCOUNTCHECKING_ACCOUNTCREDIT_CARDFINANCING_ACCOUNTINVESTMENT_ACCOUNTINVOICE_FINANCING_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZEDIndicates whether this account is either an ASSET or a LIABILITY. You can consider the balance of an ASSET as being positive, while the balance of a LIABILITY as negative.
The account type, as designated by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The account subtype, as designated by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The account name, as given by the institution.
The account number, as designated by the institution.
The branch code where the product was opened.
The check digit of the product's number, if applicable.
Details regarding the current and available balances for the account.
The current balance is calculated differently according to the type of account.
The user's account balance at the collected_at timestamp.
The amount the user has spent in the current card billing period (see credit_data.cutting_date for information on when the current billing period finishes).
The amount remaining to pay on the users's loan.
The balance that the account owner can use.
The available balance may be different to the current balance due to pending transactions.
The credit amount the user still has available for the current period. The amount is calculated as credit_data.credit_limit minus balance.current.
The present value required to pay off the loan, as provided by the institution.
Note: If the institution does not provide this value, we return null.
The amount that is currently blocked due to pending transactions.
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
The public name for the type of identification. For 🇧🇷 Brazilian savings and checking accounts, this field will be AGENCY/ACCOUNT.
The value for the public_identification_name.
For 🇧🇷 OFDA Brazilian savings and checking accounts, this field will be the agency and bank account number, separated by a slash. For example: 0444/45722-0.
For 🇧🇷 OFDA Brazilian credit card accounts, we will return a string of concatenated credit card numbers associated with the account. For example: "8763,9076,5522"
The institution's internal identification for the account.
Non-nullable: A value must be returned by Brazil's open finance network if the
balancesfield is available.
Details regarding the credit cards associated with this account.
The ISO-8601 timestamp when the data point was collected.
The upper credit limit of the card.
Non-nullable: A value must be returned by Brazil's open finance network.
The date when the credit card's bill is due.
The minimum amount that the account owner needs to pay in the current credit period.
The credit network that the card is associated with. We return one of the following values:
VISAMASTERCARDAMERICAN_EXPRESSDINERS_CLUBHIPERCARDBANDEIRA_PROPRIACHEQUE_ELETRONICOELOOTHERNon-nullable: A value must be returned by Brazil's open finance network.
Additional information about the credit card network.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
The loan options associated with this account.
The ISO-8601 timestamp when the data point was collected.
The country-specific standardized contract number.
Non-nullable: A value must be returned by Brazil's open finance network.
The initial total loan amount when the contract was signed, calculated by the institution. This amount includes the principal + interest + taxes + fees.
The initial total effective cost of the loan.
The type of the loan, according to the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The amount remaining to pay in total, including interest.
Breakdown of the interest applied to the loan. With OF Brazil, we highly recommend using the information in interest_rate_data for in-depth information.
Non-nullable: A value must be returned by Brazil's open finance network.
The name of the type of interest rate applied to the loan.
Note: For OFDA Brazil, we recommend you use the interest_date_data.tax_type parameter.
The period that the interest is applied to the loan.
Non-nullable: A value must be returned by Brazil's open finance network.
The interest rate (in percent or currency value).
Note: For OFDA Brazil, we recommend you use the interest_date_data.pre_fixed_rate and interest_date_data.post_fixed_rateparameter.
Detailed information regarding the interest rate.
The type of interest rate tax. We return one of the following values:
NOMINALEFFECTIVENon-nullable: A value must be returned by Brazil's open finance network.
The type of interest rate. We return one of the following values:
SIMPLECOMPOUNDNon-nullable: A value must be returned by Brazil's open finance network.
The period that the interest is applied to the loan.
Non-nullable: A value must be returned by Brazil's open finance network.
The base calculation for the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
The reference index rate. We return one of the following values:
WITHOUT_INDEX_TYPEPRE_FIXEDPOST_FIXEDFLOATINGINDEXED_PRICERURAL_CREDITOTHER_INDEXNon-nullable: A value must be returned by Brazil's open finance network.
The subtype of the reference index rate.
Additional information regarding the reference index rate.
The pre-fixed percentage rate of the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
The post-fixed percentage rate of the interest rate.
Non-nullable: A value must be returned by Brazil's open finance network.
Breakdown of the fees applied to the loan.
Note: This field is not applicable for OF Brazil and will return null.
The total value of the fee. Same currency as the loan.
The fee name.
Non-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
The fee code.
Non-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Indicates the type of charge. We return one of the following values:
SINGLEPER_INSTALLMENTNon-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Billing method, as agreed upon with the institution. We return one of the following values:
MINIMUMMAXIMUMFIXEDPERCENTAGENon-nullable: A value must be returned by Brazil's open finance network if the
feesfield is available.
Details regarding any loan collaterals that the individual or business supplied.
The type of collateral, as defined by the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
The subtype of the collateral, as defined by the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
collateralsfield is available.
Detailed information regarding any balloon payments for the loan, if applicable.
The frequency of contracted installment payments, as defined when the contract was first signed. We return one of the following:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnullThe frequency that the installments are paid. We return one of the following values:
IRREGULARWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYBIANNUALLYANNUALLYOTHERNon-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the installment_frequency.
The date when the first installment of the loan is to be paid, in YYYY-MM-DD format.
The total number of installments required to pay the loan.
The number of installments left to pay.
The number of installments already paid.
The number of installments that are overdue.
An array of dates when the loan was disbursed.
The date that the loan was settled, in YYYY-MM-DD format.
The date when the loan contract was signed, in YYYY-MM-DD format.
Non-nullable: A value must be returned by Brazil's open finance network.
The date when the loan is expected to be completed, in YYYY-MM-DD format.
The frequency of the remaining contracted installment payments, as defined when the contract was first signed. We return one of the following:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnullThe total number of installments remaining on the loan.
The loan amortization schedule.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the amortization_schedule.
The ID of the consignee of the loan.
The contract number of the loan, as given by the institution.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Note: This field is not applicable for OF Brazil and will return null.
Example of an checking account (OFDA Brazil).
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "institution": { … }, "collected_at": "2019-09-27T13:01:41.941Z", "created_at": "2022-02-09T08:45:50.406032Z", "last_accessed_at": "2021-03-09T10:28:40.000Z", "category": "CHECKING_ACCOUNT", "balance_type": "ASSET", "overdraft": { … }, "type": "CONTA_DEPOSITO_A_VISTA", "subtype": "INDIVIDUAL", "name": null, "number": "11188222", "agency": "6272", "check_digit": "4", "balance": { … }, "currency": "BRL", "public_identification_name": "AGENCY/NUMBER", "public_identification_value": "6272/11188222", "internal_identification": "92792126019929279212650822221989319252576", "credit_data": null, "loan_data": null, "funds_data": null } ]
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.