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.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/invoices/{id}/
https://sandbox.belvo.com/api/invoices/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/invoices/{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 fiscal institution's unique ID for the invoice.
The date of the invoice, in YYYY-MM-DD format.
The status of the invoice. Can be either Vigente (valid) or Cancelado (cancelled).
The fiscal institution's classification of the invoice.
For Mexico's SAT, we return one of the following values:
EgresoIngresoNóminaPagoTrasladoThe direction of the invoice (from the perspective of the Link owner).
OUTFLOW indicates a sent invoice.INFLOW indicates a received invoice.The tax regime of the sender, as defined by the legal entity in the country.
Indicates whether or not the sender is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.
SAT updates the tax fraud list every three months.
For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.
Possible statuses are:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS The tax regime of the receiver, as defined by the legal entity in the country.
Indicates whether or not the receiver is on SAT's tax fraud list for having submitted incorrect data, having outstanding payments, or having conducted business that is in violation of the fiscal institution's regulations.
SAT updates the tax fraud list every three months.
For more information regarding the reason's a taxpayer can be put on the tax fraud list, please see Article 69 and Article 69-B of Mexico's Código Fiscal de la Federación.
Possible statuses are:
INVESTIGATING DISMISSED CONFIRMED OVERTURNED NO_TAX_FRAUD_STATUS If the invoice is cancelled, this field indicates the status of the cancellation.
The date of the invoice cancelation, in YYYY-MM-DD format.
The date of the fiscal certification, in YYYY-MM-DD format.
The fiscal ID of the certification provider.
The payment type code used for this invoice, as defined by the country legal entity.
The payment method code used for this invoice, as defined by the legal entity of the country.
PUE, PPD, or null.The invoice's usage code, as defined by the legal entity of the country.
A list of descriptions for each item (purchased product or service provided) in the invoice.
The ISO-8601 timestamp when the data point was collected.
The description of the invoice item (an invoice can have one or more items).
The identification code of the product or the service, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico.
The unit of measure, as defined by the legal entity in the country. \n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference.
The description of the item, as defined by the legal entity in the country.\n- \U0001F1F2\U0001F1FD Mexico SAT catalog reference.
The total price for this item before tax is applied (quantity x unit_amount).
The amount of tax for this invoice item (pre_tax_amount x tax_percentage).
The total price for this invoice item (pre_tax_amount + tax_amount).
The currency of the invoice. For example:
The pretax amount of this invoice (sum of each item's pre_tax_amount).
The exchange rate used in this invoice for the currency.
The amount of tax for this invoice (sum of each item's tax_amount).
The total amount discounted in this invoice.
The total amount of the invoice (subtotal_amount + tax_amount - discount_amount)
A list detailing all the invoice payments.
ISO-8601 timestamp when the payment was made.
Payment type code used for this invoice, as defined by the country's legal entity.
The currency of the payment. For example:
Please note that other currencies other than in the list above may be returned.
The currency to MXN currency exchange rate when the payment was made.
The invoice amount, in the currency of the original invoice.
The fiscal institution's internal identifier for the operation.
The bank account number of the payment beneficiary.
The bank account number of the payment issuer.
The banking institution that was used by the payment issuer.
A list of all the related deferred invoices affected by the payment.
The fiscal institution's unique ID for the related deferred invoice.
The currency of the related invoice. For example:
🇧🇷 BRL (Brazilian Real)
🇨🇴 COP (Colombian Peso)
🇲🇽 MXN (Mexican Peso)
Please note that other currencies other than in the list above may be returned.
The invoice amount before the payment.
Details regarding the payroll payment. Only applicable for payroll invoices.
The payroll type, as defined by the legal entity of the country.
The start date of the payment period, in YYYY-MM-DD format.
The end date of the payment period, in YYYY-MM-DD format.
The ISO-8601 timestamp when the data point was collected.
How often the payroll payment is made.
For Mexico's SAT, we return one of the following values:
DAILYWEEKLYTENTH_DAYFOURTEENTH_DAYFIFTEENTH_DAYMONTHLYBIMONTHLYPER_TASKCOMMISSIONONE_OFFOTHER_PERIODICITYA breakdown of the earnings for the payroll payment.
A breakdown of the tax deductions on the payroll payment.
The internal control number that the taxpayer assigns to the invoice.
The export type of the invoice, as defined by the legal entity in the country. For more information, see our SAT catalog reference article.
This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.
This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation.
The description of the payment method used for this invoice.
This field has been deprecated. For more information regarding Belvo and deprecation, see our Deprecated fields explanation. Please use sender_tax_fraud_status instead.
Example of an Igreso type invoice.
{ "id": "90d90e38-0087-4b6d-b6dc-94ea561bb9cb", "link": "1bd948f7-245d-4313-b604-34d1044cb908", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:46:20.406032Z", "invoice_identification": "862B9918-3K6H-4E0B-NAI9-2BE2D833B840", "invoice_date": "2020-12-24", "status": "Vigente", "invoice_type": "Ingreso", "type": "OUTFLOW", "sender_id": "GHTF980303F7", "sender_name": "Roberto Martinez Diaz", "sender_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "receiver_id": "MNMK3203409H1", "receiver_name": "ACNE SA DE CV", "receiver_tax_fraud_status": "NO_TAX_FRAUD_STATUS", "cancelation_status": null, "cancelation_update_date": null, "certification_date": "2020-12-24", "certification_authority": "FGV330542BG6", "payment_type": "04", "payment_type_description": null, "payment_method": "PUE", "usage": "G03", "place_of_issue": "11000", "version": "3.3", "invoice_details": [ { … } ], "currency": "MXN", "subtotal_amount": 25, "exchange_rate": 1, "tax_amount": 4, "discount_amount": 0, "total_amount": 29, "payments": [], "payroll": null, "folio": "28", "xml": "=XML-STRING=", "warnings": { "code": "warning_code", "message": "warning message" } }
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/invoices/{id}/
https://sandbox.belvo.com/api/invoices/{id}/
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/invoices/{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.