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:
Retrieve transactions for one or more accounts from a specific link.
📘 Transaction Periods and Retrieval
When retrieving transactions, it is important to understand that the available transaction data ranges depend on each institution. If you try to access older information than what we can access, we will return all the data we can read within that date range. For example, if you request transactions for the last year and we can only access the last six months, we will return the information corresponding to these six months of data.
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.
Recommended header parameter to make your POST request asynchronous (thus preventing timeouts and improving your data flow).
When you make an asynchronous request, Belvo responds with a 202 - Accepted
payload, including the request_id
. Once we have retrieved the requested information, you will receive a webhook with the link and request IDs.
The link.id
you want to retrieve information for.
If provided, we return transactions only from this account.
The date from which you want to start getting data for, in YYYY-MM-DD
format.
⚠️ The value of date_from
cannot be greater than date_to
.
The date you want to stop getting data for, in YYYY-MM-DD
format.
⚠️ The value of date_to
cannot be greater than today's date (in other words, no future dates).
The MFA token generated by the institution which is required to continue a session.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/transactions/
https://sandbox.belvo.com/api/transactions/
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/transactions/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-H 'X-Belvo-Request-Mode: async' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
"date_from": "2020-08-05",
"date_to": "2020-10-05",
"token": "1234ab",
"save_data": true
}'
Ok (when save_data=false
)
Belvo's unique identifier for the current item.
The institution's internal identification for the transaction.
Non-nullable: A value must be returned by Brazil's open finance network.
Details regarding the account.
Belvo's unique identifier for the current item.
The link.id
the data belongs to.
Details regarding the institution.
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_ACCOUNT
CHECKING_ACCOUNT
CREDIT_CARD
FINANCING_ACCOUNT
INVESTMENT_ACCOUNT
INVOICE_FINANCING_ACCOUNT
LOAN_ACCOUNT
PENSION_FUND_ACCOUNT
SAVINGS_ACCOUNT
UNCATEGORIZED
Indicates 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
balances
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
balances
field 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
balances
field 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:
VISA
MASTERCARD
AMERICAN_EXPRESS
DINERS_CLUB
HIPERCARD
BANDEIRA_PROPRIA
CHEQUE_ELETRONICO
ELO
OTHER
Non-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_rate
parameter.
Detailed information regarding the interest rate.
The type of interest rate tax. We return one of the following values:
NOMINAL
EFFECTIVE
Non-nullable: A value must be returned by Brazil's open finance network.
The type of interest rate. We return one of the following values:
SIMPLE
COMPOUND
Non-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_TYPE
PRE_FIXED
POST_FIXED
FLOATING
INDEXED_PRICE
RURAL_CREDIT
OTHER_INDEX
Non-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
fees
field is available.
The fee code.
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Indicates the type of charge. We return one of the following values:
SINGLE
PER_INSTALLMENT
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Billing method, as agreed upon with the institution. We return one of the following values:
MINIMUM
MAXIMUM
FIXED
PERCENTAGE
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field 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
collaterals
field 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
collaterals
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
collaterals
field 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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The frequency that the installments are paid. We return one of the following values:
IRREGULAR
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHER
Non-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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The 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.
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 date when the transaction occurred, in YYYY-MM-DD
format, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network.
The ISO-8601 timestamp of when the transaction occurred (in the UTC timezone).
Note: For transactions that occurred before 31.01.2024, the timestamp may only indicate the day (for example,
2016-01-29T00:00:00.000Z
). However, transactions that occurred after this date must include the date and time (2024-02-20T12:29:03.374Z
).
Institutions not abiding by this format: Some institutions may not provide the exact time of the transaction. In this case, the timestamp will be set to
00:00:00.000Z
. Belvo has identified the following institutions as not abiding by the regulation and have raised the issue with regulators: Bradesco, Itau, and Sicoob.
Non-nullable: A value must be returned by Brazil's open finance network for credit card and checking account transactions.
The date when the transaction was processed and accounted for by the institution, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
In the case that the transaction occured on a weekend or public holiday, Belvo will infer the date that the transaction is accounted for by the institution. Typically, this is the next business day.
The transaction amount. ℹ️ The amount displayed is always positive as we indicate the direction of the transaction in the type
parameter.
Non-nullable: A value must be returned by Brazil's open finance network.
The value of the transaction in the local currency.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
Note: This field is not applicable for OF Brazil and will return null.
The three-letter currency code (ISO-4217).
The description of transaction provided by the institution. Usually this is the text that the end user sees in the online platform.
Non-nullable: A value must be returned by Brazil's open finance network.
Note: This field is not applicable for OF Brazil and will return null.
Additional data regarding the merchant involved in the transaction. We only return merchant information for new transactions made from checking or credit card accounts.
Get merchant information We retrieve the merchant information for a transaction as part of our Transaction categorization product, turning raw data into actionable insights. To enable this product, just reach out to us, and we'll get right to it.
The name of the transaction category.
Get transaction categorization With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Bills & Utilities
Credits & Loans
Deposits
Fees & Charges
Food & Groceries
Home & Life
Income & Payments
Insurance
Investments & Savings
Online Platforms & Leisure
Personal Shopping
Taxes
Transfers
Transport & Travel
Unknown
*Withdrawal & ATM
null
* For clients not using our Transaction Categorization product, we return null
instead.
The transaction subcategory.
Get transaction categorization For clients not using our Transaction categorization, we return
null
instead. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Electricity & Energy
Rent
Telecommunications
Water
Auto
Credit Card
Instalment
Interest & Charges
Mortgage
Pay Advance
Personal
Adjustments
Bank Fees
Chargeback
Refund
Blocked Balances
Alimony
Alcohol & Tobacco
Bakery & Coffee
Bars & Nightclubs
Convenience Store
Delivery
Groceries
Restaurants
Education
Gyms & Fitness
Hair & Beauty
Health
Home Decor & Appliances
Laundry & Dry Cleaning
Pharmacies
Professional Services
Veterinary Services
Freelance
Interest
Retirement
Salary
Government
Home Insurance
Auto Insurance
Health & Life Insurance
Savings
Fixed income
Equity
Investment Funds
Derivatives
Cryptocurrencies
Apps, Software and Cloud Services
Events, Parks and Museums
Gambling
Gaming
Lottery
Movie & Audio
Books & News
Clothing & Accessories
Department Store
Electronics
E-commerce
Gifts
Office Supplies
Pet Supplies
Auto Tax & Fees
Donation
Government Fees
Income Tax
Real Estate Tax & Fees
Tax Return
Accommodation
Auto Expenses
Auto Rental
Flights
Gas
Mileage Programs
Parking & Tolls
Public Transit
Taxis & Rideshares
Other
null
Note: This field is not applicable for OF Brazil and will return null.
The direction of the transaction:
INFLOW
indicates money coming into the account.OUTFLOW
indicates money going out of the account.null
when no information was present regarding the direction of the transaction.The status of the transaction. We return one of the following values:
PROCESSED
(The transaction has been processed by the institution.)PENDING
(The institution clearly states that the transaction has not yet been processed.)UNCATEGORIZED
(deprecated)null
(deprecated)Additional data provided by the institution for credit card transactions.
The ISO-8601 timestamp when the data point was collected.
The title of the monthly credit card bill the transaction belongs to. The format of the returned value is institution specific, however, some common examples are:
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The date that the bill is due to be paid, in YYYY-MM-DD
format.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The institution's internal identifier for the bill.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
The bill amount, as of collected_at
. For more information, see credit_card_bill
.
The credit card number.
Note: Often, this is just the last four digit of the credit card.
Non-nullable: A value must be returned by Brazil's open finance network.
The fee that can be charged for a card transaction. We return one of the following values:
ANNUAL_FEE
NATIONAL_WITHDRAWAL
INTERNATIONAL_WITHDRAWAL
EMERGENCY_CREDIT_EVALUATION_FEE
DUPLICATE_ISSUANCE_FEE
PAYMENT_FEE
SMS_FEE
OTHERS
null
Additional information regarding the fee.
Other types of credit that have been contracted on the card. We return one of the following values:
REVOLVING_CREDIT
BILL_INSTALLMENT_PAYMENT
LOAN
OTHERS
null
Additional information regarding the credit type.
An identifier for the installment, according to the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The total number of installments for the card transaction, if applicable.
Information regarding the other party of this transaction, if available.
The transaction counterparty type. We return one of the following values:
INDIVIDUAL
COMPANY
null
The document number of the representative.
Note:
For Brazil:
type
is INDIVIDUAL
, this is the CPF number.type
is COMPANY
, this is the CNPJ number.The branch code where the account was opened.
The check digit of the account number, if applicable.
Information regarding the loan transactional data, if applicable.
Boolean to indicate whether or not this loan payment was part of the original payment schedule.
Non-nullable: A value must be returned by Brazil's open finance network.
The institution's unique ID for this payment installment.
Details regarding the fees associated with this payment. Only applicable when is_detached
= true
.
The name of the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
The institution's code for the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
Details regarding the charges associated with this payment. Only applicable when is_detached
= true
.
The type of charge.
Non-nullable: A value must be returned by Brazil's open finance network when the
charges
field is present
Additional information regarding the charge type
.
The transaction payment type. We return one of the following values:
FULL
INSTALLMENT
null
The type of transaction. For example, a PIX payment or a deposit.
Non-nullable: A value must be returned by Brazil's open finance network for non-loan account transactions.
Additional information regarding the operation_type
, if applicable.
The four-digit (ISO-18245 compliant) Merchant Category Code (MCC) for the transaction. This field is only applicable for credit card transactions.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl", "account": { … }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "value_date": "2019-10-23", "transacted_at": "2024-02-20T12:29:03.374Z", "accounting_date": "2019-10-23", "inferred_accounting_date": "2019-10-23", "amount": 2145.45, "local_currency_amount": 7623.64, "balance": null, "currency": "BRL", "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", "observations": null, "merchant": { … }, "category": "Income & Payments", "subcategory": "Freelance", "reference": null, "type": "INFLOW", "status": "PROCESSED", "credit_card_data": { … }, "counterparty": { … }, "loan_data": { … }, "payment_type": "FULL", "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", "operation_type_additional_info": "Internal transfer.", "mcc": 5137 } ]
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/transactions/
https://sandbox.belvo.com/api/transactions/
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/transactions/?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 institution's internal identification for the transaction.
Non-nullable: A value must be returned by Brazil's open finance network.
Details regarding the account.
Belvo's unique identifier for the current item.
The link.id
the data belongs to.
Details regarding the institution.
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_ACCOUNT
CHECKING_ACCOUNT
CREDIT_CARD
FINANCING_ACCOUNT
INVESTMENT_ACCOUNT
INVOICE_FINANCING_ACCOUNT
LOAN_ACCOUNT
PENSION_FUND_ACCOUNT
SAVINGS_ACCOUNT
UNCATEGORIZED
Indicates 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
balances
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
balances
field 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
balances
field 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:
VISA
MASTERCARD
AMERICAN_EXPRESS
DINERS_CLUB
HIPERCARD
BANDEIRA_PROPRIA
CHEQUE_ELETRONICO
ELO
OTHER
Non-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_rate
parameter.
Detailed information regarding the interest rate.
The type of interest rate tax. We return one of the following values:
NOMINAL
EFFECTIVE
Non-nullable: A value must be returned by Brazil's open finance network.
The type of interest rate. We return one of the following values:
SIMPLE
COMPOUND
Non-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_TYPE
PRE_FIXED
POST_FIXED
FLOATING
INDEXED_PRICE
RURAL_CREDIT
OTHER_INDEX
Non-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
fees
field is available.
The fee code.
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Indicates the type of charge. We return one of the following values:
SINGLE
PER_INSTALLMENT
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Billing method, as agreed upon with the institution. We return one of the following values:
MINIMUM
MAXIMUM
FIXED
PERCENTAGE
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field 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
collaterals
field 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
collaterals
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
collaterals
field 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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The frequency that the installments are paid. We return one of the following values:
IRREGULAR
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHER
Non-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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The 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.
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 date when the transaction occurred, in YYYY-MM-DD
format, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network.
The ISO-8601 timestamp of when the transaction occurred (in the UTC timezone).
Note: For transactions that occurred before 31.01.2024, the timestamp may only indicate the day (for example,
2016-01-29T00:00:00.000Z
). However, transactions that occurred after this date must include the date and time (2024-02-20T12:29:03.374Z
).
Institutions not abiding by this format: Some institutions may not provide the exact time of the transaction. In this case, the timestamp will be set to
00:00:00.000Z
. Belvo has identified the following institutions as not abiding by the regulation and have raised the issue with regulators: Bradesco, Itau, and Sicoob.
Non-nullable: A value must be returned by Brazil's open finance network for credit card and checking account transactions.
The date when the transaction was processed and accounted for by the institution, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
In the case that the transaction occured on a weekend or public holiday, Belvo will infer the date that the transaction is accounted for by the institution. Typically, this is the next business day.
The transaction amount. ℹ️ The amount displayed is always positive as we indicate the direction of the transaction in the type
parameter.
Non-nullable: A value must be returned by Brazil's open finance network.
The value of the transaction in the local currency.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
Note: This field is not applicable for OF Brazil and will return null.
The three-letter currency code (ISO-4217).
The description of transaction provided by the institution. Usually this is the text that the end user sees in the online platform.
Non-nullable: A value must be returned by Brazil's open finance network.
Note: This field is not applicable for OF Brazil and will return null.
Additional data regarding the merchant involved in the transaction. We only return merchant information for new transactions made from checking or credit card accounts.
Get merchant information We retrieve the merchant information for a transaction as part of our Transaction categorization product, turning raw data into actionable insights. To enable this product, just reach out to us, and we'll get right to it.
The name of the transaction category.
Get transaction categorization With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Bills & Utilities
Credits & Loans
Deposits
Fees & Charges
Food & Groceries
Home & Life
Income & Payments
Insurance
Investments & Savings
Online Platforms & Leisure
Personal Shopping
Taxes
Transfers
Transport & Travel
Unknown
*Withdrawal & ATM
null
* For clients not using our Transaction Categorization product, we return null
instead.
The transaction subcategory.
Get transaction categorization For clients not using our Transaction categorization, we return
null
instead. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Electricity & Energy
Rent
Telecommunications
Water
Auto
Credit Card
Instalment
Interest & Charges
Mortgage
Pay Advance
Personal
Adjustments
Bank Fees
Chargeback
Refund
Blocked Balances
Alimony
Alcohol & Tobacco
Bakery & Coffee
Bars & Nightclubs
Convenience Store
Delivery
Groceries
Restaurants
Education
Gyms & Fitness
Hair & Beauty
Health
Home Decor & Appliances
Laundry & Dry Cleaning
Pharmacies
Professional Services
Veterinary Services
Freelance
Interest
Retirement
Salary
Government
Home Insurance
Auto Insurance
Health & Life Insurance
Savings
Fixed income
Equity
Investment Funds
Derivatives
Cryptocurrencies
Apps, Software and Cloud Services
Events, Parks and Museums
Gambling
Gaming
Lottery
Movie & Audio
Books & News
Clothing & Accessories
Department Store
Electronics
E-commerce
Gifts
Office Supplies
Pet Supplies
Auto Tax & Fees
Donation
Government Fees
Income Tax
Real Estate Tax & Fees
Tax Return
Accommodation
Auto Expenses
Auto Rental
Flights
Gas
Mileage Programs
Parking & Tolls
Public Transit
Taxis & Rideshares
Other
null
Note: This field is not applicable for OF Brazil and will return null.
The direction of the transaction:
INFLOW
indicates money coming into the account.OUTFLOW
indicates money going out of the account.null
when no information was present regarding the direction of the transaction.The status of the transaction. We return one of the following values:
PROCESSED
(The transaction has been processed by the institution.)PENDING
(The institution clearly states that the transaction has not yet been processed.)UNCATEGORIZED
(deprecated)null
(deprecated)Additional data provided by the institution for credit card transactions.
The ISO-8601 timestamp when the data point was collected.
The title of the monthly credit card bill the transaction belongs to. The format of the returned value is institution specific, however, some common examples are:
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The date that the bill is due to be paid, in YYYY-MM-DD
format.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The institution's internal identifier for the bill.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
The bill amount, as of collected_at
. For more information, see credit_card_bill
.
The credit card number.
Note: Often, this is just the last four digit of the credit card.
Non-nullable: A value must be returned by Brazil's open finance network.
The fee that can be charged for a card transaction. We return one of the following values:
ANNUAL_FEE
NATIONAL_WITHDRAWAL
INTERNATIONAL_WITHDRAWAL
EMERGENCY_CREDIT_EVALUATION_FEE
DUPLICATE_ISSUANCE_FEE
PAYMENT_FEE
SMS_FEE
OTHERS
null
Additional information regarding the fee.
Other types of credit that have been contracted on the card. We return one of the following values:
REVOLVING_CREDIT
BILL_INSTALLMENT_PAYMENT
LOAN
OTHERS
null
Additional information regarding the credit type.
An identifier for the installment, according to the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The total number of installments for the card transaction, if applicable.
Information regarding the other party of this transaction, if available.
The transaction counterparty type. We return one of the following values:
INDIVIDUAL
COMPANY
null
The document number of the representative.
Note:
For Brazil:
type
is INDIVIDUAL
, this is the CPF number.type
is COMPANY
, this is the CNPJ number.The branch code where the account was opened.
The check digit of the account number, if applicable.
Information regarding the loan transactional data, if applicable.
Boolean to indicate whether or not this loan payment was part of the original payment schedule.
Non-nullable: A value must be returned by Brazil's open finance network.
The institution's unique ID for this payment installment.
Details regarding the fees associated with this payment. Only applicable when is_detached
= true
.
The name of the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
The institution's code for the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
Details regarding the charges associated with this payment. Only applicable when is_detached
= true
.
The type of charge.
Non-nullable: A value must be returned by Brazil's open finance network when the
charges
field is present
Additional information regarding the charge type
.
The transaction payment type. We return one of the following values:
FULL
INSTALLMENT
null
The type of transaction. For example, a PIX payment or a deposit.
Non-nullable: A value must be returned by Brazil's open finance network for non-loan account transactions.
Additional information regarding the operation_type
, if applicable.
The four-digit (ISO-18245 compliant) Merchant Category Code (MCC) for the transaction. This field is only applicable for credit card transactions.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl", "account": { … }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "value_date": "2019-10-23", "transacted_at": "2024-02-20T12:29:03.374Z", "accounting_date": "2019-10-23", "inferred_accounting_date": "2019-10-23", "amount": 2145.45, "local_currency_amount": 7623.64, "balance": null, "currency": "BRL", "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", "observations": null, "merchant": { … }, "category": "Income & Payments", "subcategory": "Freelance", "reference": null, "type": "INFLOW", "status": "PROCESSED", "credit_card_data": { … }, "counterparty": { … }, "loan_data": { … }, "payment_type": "FULL", "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", "operation_type_additional_info": "Internal transfer.", "mcc": 5137 } ]
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/transactions/{id}/
https://sandbox.belvo.com/api/transactions/{id}/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/transactions/{id}/?fields=string&omit=string'
Ok
Belvo's unique identifier for the current item.
The institution's internal identification for the transaction.
Non-nullable: A value must be returned by Brazil's open finance network.
Details regarding the account.
Belvo's unique identifier for the current item.
The link.id
the data belongs to.
Details regarding the institution.
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_ACCOUNT
CHECKING_ACCOUNT
CREDIT_CARD
FINANCING_ACCOUNT
INVESTMENT_ACCOUNT
INVOICE_FINANCING_ACCOUNT
LOAN_ACCOUNT
PENSION_FUND_ACCOUNT
SAVINGS_ACCOUNT
UNCATEGORIZED
Indicates 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
balances
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
balances
field 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
balances
field 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:
VISA
MASTERCARD
AMERICAN_EXPRESS
DINERS_CLUB
HIPERCARD
BANDEIRA_PROPRIA
CHEQUE_ELETRONICO
ELO
OTHER
Non-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_rate
parameter.
Detailed information regarding the interest rate.
The type of interest rate tax. We return one of the following values:
NOMINAL
EFFECTIVE
Non-nullable: A value must be returned by Brazil's open finance network.
The type of interest rate. We return one of the following values:
SIMPLE
COMPOUND
Non-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_TYPE
PRE_FIXED
POST_FIXED
FLOATING
INDEXED_PRICE
RURAL_CREDIT
OTHER_INDEX
Non-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
fees
field is available.
The fee code.
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Indicates the type of charge. We return one of the following values:
SINGLE
PER_INSTALLMENT
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field is available.
Billing method, as agreed upon with the institution. We return one of the following values:
MINIMUM
MAXIMUM
FIXED
PERCENTAGE
Non-nullable: A value must be returned by Brazil's open finance network if the
fees
field 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
collaterals
field 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
collaterals
field is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network if the
collaterals
field 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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The frequency that the installments are paid. We return one of the following values:
IRREGULAR
WEEKLY
FORTNIGHTLY
MONTHLY
BIMONTHLY
QUARTERLY
BIANNUALLY
ANNUALLY
OTHER
Non-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:
DAY
WEEK
MONTH
YEAR
NO_DEADLINE_REMAINING
null
The 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.
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 date when the transaction occurred, in YYYY-MM-DD
format, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network.
The ISO-8601 timestamp of when the transaction occurred (in the UTC timezone).
Note: For transactions that occurred before 31.01.2024, the timestamp may only indicate the day (for example,
2016-01-29T00:00:00.000Z
). However, transactions that occurred after this date must include the date and time (2024-02-20T12:29:03.374Z
).
Institutions not abiding by this format: Some institutions may not provide the exact time of the transaction. In this case, the timestamp will be set to
00:00:00.000Z
. Belvo has identified the following institutions as not abiding by the regulation and have raised the issue with regulators: Bradesco, Itau, and Sicoob.
Non-nullable: A value must be returned by Brazil's open finance network for credit card and checking account transactions.
The date when the transaction was processed and accounted for by the institution, in YYYY-MM-DD
format.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
In the case that the transaction occured on a weekend or public holiday, Belvo will infer the date that the transaction is accounted for by the institution. Typically, this is the next business day.
The transaction amount. ℹ️ The amount displayed is always positive as we indicate the direction of the transaction in the type
parameter.
Non-nullable: A value must be returned by Brazil's open finance network.
The value of the transaction in the local currency.
Non-nullable: A value must be returned by Brazil's open finance network for credit card transactions.
Note: This field is not applicable for OF Brazil and will return null.
The three-letter currency code (ISO-4217).
The description of transaction provided by the institution. Usually this is the text that the end user sees in the online platform.
Non-nullable: A value must be returned by Brazil's open finance network.
Note: This field is not applicable for OF Brazil and will return null.
Additional data regarding the merchant involved in the transaction. We only return merchant information for new transactions made from checking or credit card accounts.
Get merchant information We retrieve the merchant information for a transaction as part of our Transaction categorization product, turning raw data into actionable insights. To enable this product, just reach out to us, and we'll get right to it.
The name of the transaction category.
Get transaction categorization With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Bills & Utilities
Credits & Loans
Deposits
Fees & Charges
Food & Groceries
Home & Life
Income & Payments
Insurance
Investments & Savings
Online Platforms & Leisure
Personal Shopping
Taxes
Transfers
Transport & Travel
Unknown
*Withdrawal & ATM
null
* For clients not using our Transaction Categorization product, we return null
instead.
The transaction subcategory.
Get transaction categorization For clients not using our Transaction categorization, we return
null
instead. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Electricity & Energy
Rent
Telecommunications
Water
Auto
Credit Card
Instalment
Interest & Charges
Mortgage
Pay Advance
Personal
Adjustments
Bank Fees
Chargeback
Refund
Blocked Balances
Alimony
Alcohol & Tobacco
Bakery & Coffee
Bars & Nightclubs
Convenience Store
Delivery
Groceries
Restaurants
Education
Gyms & Fitness
Hair & Beauty
Health
Home Decor & Appliances
Laundry & Dry Cleaning
Pharmacies
Professional Services
Veterinary Services
Freelance
Interest
Retirement
Salary
Government
Home Insurance
Auto Insurance
Health & Life Insurance
Savings
Fixed income
Equity
Investment Funds
Derivatives
Cryptocurrencies
Apps, Software and Cloud Services
Events, Parks and Museums
Gambling
Gaming
Lottery
Movie & Audio
Books & News
Clothing & Accessories
Department Store
Electronics
E-commerce
Gifts
Office Supplies
Pet Supplies
Auto Tax & Fees
Donation
Government Fees
Income Tax
Real Estate Tax & Fees
Tax Return
Accommodation
Auto Expenses
Auto Rental
Flights
Gas
Mileage Programs
Parking & Tolls
Public Transit
Taxis & Rideshares
Other
null
Note: This field is not applicable for OF Brazil and will return null.
The direction of the transaction:
INFLOW
indicates money coming into the account.OUTFLOW
indicates money going out of the account.null
when no information was present regarding the direction of the transaction.The status of the transaction. We return one of the following values:
PROCESSED
(The transaction has been processed by the institution.)PENDING
(The institution clearly states that the transaction has not yet been processed.)UNCATEGORIZED
(deprecated)null
(deprecated)Additional data provided by the institution for credit card transactions.
The ISO-8601 timestamp when the data point was collected.
The title of the monthly credit card bill the transaction belongs to. The format of the returned value is institution specific, however, some common examples are:
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The date that the bill is due to be paid, in YYYY-MM-DD
format.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
The institution's internal identifier for the bill.
Note: This field is only returned for 'closed' bills (meaning the billing period has ended and the bill has been emitted). If the billing period is still ongoing, we return
null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
Note: This field is not applicable for OFDA Brazil and will return null
.
The bill amount, as of collected_at
. For more information, see credit_card_bill
.
The credit card number.
Note: Often, this is just the last four digit of the credit card.
Non-nullable: A value must be returned by Brazil's open finance network.
The fee that can be charged for a card transaction. We return one of the following values:
ANNUAL_FEE
NATIONAL_WITHDRAWAL
INTERNATIONAL_WITHDRAWAL
EMERGENCY_CREDIT_EVALUATION_FEE
DUPLICATE_ISSUANCE_FEE
PAYMENT_FEE
SMS_FEE
OTHERS
null
Additional information regarding the fee.
Other types of credit that have been contracted on the card. We return one of the following values:
REVOLVING_CREDIT
BILL_INSTALLMENT_PAYMENT
LOAN
OTHERS
null
Additional information regarding the credit type.
An identifier for the installment, according to the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The total number of installments for the card transaction, if applicable.
Information regarding the other party of this transaction, if available.
The transaction counterparty type. We return one of the following values:
INDIVIDUAL
COMPANY
null
The document number of the representative.
Note:
For Brazil:
type
is INDIVIDUAL
, this is the CPF number.type
is COMPANY
, this is the CNPJ number.The branch code where the account was opened.
The check digit of the account number, if applicable.
Information regarding the loan transactional data, if applicable.
Boolean to indicate whether or not this loan payment was part of the original payment schedule.
Non-nullable: A value must be returned by Brazil's open finance network.
The institution's unique ID for this payment installment.
Details regarding the fees associated with this payment. Only applicable when is_detached
= true
.
The name of the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
The institution's code for the fee.
Non-nullable: A value must be returned by Brazil's open finance network when the
fees
field is present.
Details regarding the charges associated with this payment. Only applicable when is_detached
= true
.
The type of charge.
Non-nullable: A value must be returned by Brazil's open finance network when the
charges
field is present
Additional information regarding the charge type
.
The transaction payment type. We return one of the following values:
FULL
INSTALLMENT
null
The type of transaction. For example, a PIX payment or a deposit.
Non-nullable: A value must be returned by Brazil's open finance network for non-loan account transactions.
Additional information regarding the operation_type
, if applicable.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl", "account": { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "institution": { … }, "collected_at": "2022-02-09T08:45:50.406032Z", "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": "STANDARD_NACIONAL", "subtype": "FINANCIAMENTO_HABITACIONAL_SFH", "name": "Cuenta Perfiles- M.N. - MXN-666", "number": "4057068115181", "agency": "6272", "check_digit": "7", "balance": { … }, "currency": "BRL", "public_identification_name": "AGENCY/ACCOUNT", "public_identification_value": "0444/45722-0", "internal_identification": "92792126019929279212650822221989319252576", "credit_data": { … }, "loan_data": { … }, "funds_data": null }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "value_date": "2019-10-23", "transacted_at": "2024-02-20T12:29:03.374Z", "accounting_date": "2019-10-23", "inferred_accounting_date": "2019-10-23", "amount": 2145.45, "local_currency_amount": 7623.64, "balance": null, "currency": "BRL", "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", "observations": null, "merchant": { "logo": "https://logo.clearbit.com/asesor-contable.es", "website": "https://merchants-r-us.com", "merchant_name": "Merchants R Us Global" }, "category": "Income & Payments", "subcategory": "Freelance", "reference": null, "type": "INFLOW", "status": "PROCESSED", "credit_card_data": { "collected_at": "2022-02-09T08:45:50.406032Z", "bill_name": "apr-2020", "bill_due_date": "2023-06-17", "bill_internal_identification": "927921260199292792126508222219893192525A6", "bill_status": null, "previous_bill_total": null, "bill_amount": 300, "card_number": "4453", "fee_type": "NATIONAL_WITHDRAWAL", "fee_type_additional_info": "ATM withdrawal in Curitiba.", "credits_type": "BILL_INSTALLMENT_PAYMENT", "credits_type_additional_info": "Some additional information.", "installment_identifier": "PARCELA_896", "number_of_installments": 4, "credit_card_bill": { … } }, "counterparty": { "type": "INDIVIDUAL", "document_number": "73677831148", "clearing_code": "001", "agency": "6272", "check_digit": "7", "number": "24550245" }, "loan_data": { "is_detached": true, "installment_id": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH", "fees": [ … ], "charges": [ … ] }, "payment_type": "FULL", "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", "operation_type_additional_info": "Internal transfer.", "mcc": 5137 }
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_type
in theform_fields
array, you must send through this value in your PATCH request.