Banking aggregation
Our Banking product lets you access account, balance, income, owner, and transaction data to get a comprehensive view of your end user.
We refer to links created with banking institutions (such as Santander or Bradesco) as banking links.
Business banks and additional requests
With business or commercial banks that require MFA, you can access data for up to 30 minutes after a user provides their authentication token.
In other words, after a user provides their authentication token to, for example, connect their account, you can make POST calls to the institution for up to 30 minutes before needing to request a new authentication token.
Accounts
Our Accounts resource provides you with information regarding the bank account in a financial institution. A user can have several Accounts inside each Link. For example, one Link can have one checking account, several credit cards, and even loan accounts.
Use this resource to get information about a banking link's:
- account type and category
- current account balance
- account currency
- and so much more
We offer the following methods when it comes to interacting with Accounts:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve all accounts related to a specific link. |
| List | GET | List all the accounts from all the Links already associated with your Belvo account. |
| Resume | PATCH | Resume an Account Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific account. |
| Destroy | DELETE | Delete a specific account and all associated transactions from your Belvo API key. |
Owners
Our Owners resource provides you information regarding the person who is the owner of each account within a Link.
Use this resource to get information about a link owner's:
- full name
- phone number
- mailing address
- email address
We offer the following methods when it comes to interacting with Owners:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve the owner detail of a specific link. |
| List | GET | List all owners associated to your Belvo account. |
| Resume | PATCH | Resume an Owner Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific owner. |
| Destroy | DELETE | Delete a specific owner from your Belvo account. |
Employment aggregation supports owners too!
For each employment aggregation link you create, you can also query the owners resource to get key information about the user.
Transactions
Our Transactions resource provides you with detailed transactional information for an end user.
Use this resource to get information about a link's:
- transaction history
- the category for each transaction
- the status of each transaction
We offer the following methods when it comes to interacting with Transactions:
| Endpoints | Method | Description |
|---|---|---|
| Retrieve | POST | Retrieve all transactions related to a specific account within a data range. |
| List | GET | List all the transactions from all Links you have access to. |
| Resume | PATCH | Resume a Transaction Retrieve session that was paused because an MFA token was required by the institution. |
| Detail | GET | Get the details of a specific transaction, using the transaction ID. |
| Destroy | DELETE | Delete a specific transaction from your Belvo account. |
Categorizing transactions
Belvo’s Transaction categorization helps you understand and analyze data by categorizing your transactions. This means we use a combination of internal and external data sources to provide a standardized category and subcategory for each transaction as well as additional data regarding the merchant involved (name, logo, website URL). By categorizing your transactions you will gain:
- actionable insight into your user’s income and spending habits
- opportunities to improve your user’s financial health
Every time you make a POST request to our Transactions resource or a new transaction is identified for a recurrent link, Belvo enriches these transactions with an assigned category, subcategory, and merchant information (merchant’s name, logo, and website URL).
Here is the list of transaction categories and subcategories we support:
Get Transaction categorization
If you want to opt in to enable Transaction categorization, just reach out to us and we’ll get right to it 😎. For clients not using our Transaction categorization product, we return
nullinstead.
| Category | Subcategory | Transaction type |
|---|---|---|
Bills & Utilities | -Electricity & Energy: recurrent bills and expenses, such as electricity, energy, and gas bills.- Rent: rent payments.- Telecommunications: telecommunication expenses such as Internet service or mobile services.- Water: water bills.- Other: other bill & utilities related transactions. | Outflow Inflow |
Credits & Loans | - Auto: loans and leases for motorized vehicles including cars and motorcycles.- Credit Card: credit card payments.- Instalment: Instalments payments.- Interest & Charges: fees and charges for missed payments, credit interests, and other penalties.- Mortgage: mortgage loan payments.- Pay Advance: salary advances, including payday loans.- Personal: personal loans, including credit card cash advances, “buy now pay later” (BNPL), high-cost short-term credit, and microloans.- Other: transactions related to credits & loans that do not fit in any of the above subcategories. | Outflow Inflow |
Deposits | N/A - ATM deposits, prepaid card top-ups, account top-ups. | Outflow Inflow |
Fees & Charges | - Adjustments: Adjustments made to account balances.- Bank Fees: charges for account maintenance and other services.- Chargeback: reversed transactions related to customers’ disputes for their credit or debit card.- Refund: transactions when a product is returned or a purchase is canceled by the store or the company and the customer is refunded the amount paid for the item.- Blocked Balances: blocked balances by financial institutions or through judicial channels.- Alimony: financial support transactions that one spouse provides to the other after separation.- Other: transactions related to fees & charges that do not fit in any of the above subcategories. | Outflow Inflow |
Food & Groceries | - Alcohol & Tobacco: purchases in liquor stores, including beer, wine, tobacco, and smoking products like electronic cigarettes.- Bakery & Coffee: purchases bakery items and coffee.- Bars & Nightclubs: bars, cocktails lounges, discotheques, nightclubs, and taverns selling alcoholic beverages.- Convenience Store: transactions related to purchasing items from convenience stores.- Delivery: delivery purchases.- Groceries: purchases of fresh produce and groceries, including farmers’ markets.- Restaurants: dining expenses, fast food chains.- Other: transactions related to food and groceries that do not fit in any of the above subcategories. | Outflow Inflow |
Home & Life | - Education: educational expenses such as tuition fees, textbooks, and school supplies.- Gyms & Fitness: gym and fitness centers, personal training, workout classes, memberships (including country clubs and private golf courses).- Hair & Beauty: manicures, haircuts, waxing, spa and massage services, and bath and beauty products.- Health: dental, optician, and medical expenses.- Home Decor & Appliances: furniture, bedding, and home accessories and appliances.- Laundry & Dry Cleaning: wash and fold, and dry cleaning expenses.- Pharmacies: pharmacies, drugstores, nutrition, and vitamin shops.- Professional Services: professional services, consulting fees, and other types of service-based payments.- Veterinary Services: prevention and care procedures for animals and pets.- Other: transactions related to home & life that do not fit in any of the above subcategories. | Outflow Inflow |
Income & Payments | - Freelance: income earned from freelance work or self-employment.- Interest: interests on loans and bank balance.- Retirement: income from pension programs.- Salary: salary payments.- Government: Income received from the government, such as Social Security or unemployment benefits.- Rent: passive incomes from property rental (such as residential housing and commercial facilities).- Other: transactions related to income & payments that do not fit in any of the above subcategories. | Inflow |
Insurance | - Home Insurance: home insurance, renter's insurance, earthquake insurance, and similar transactions.- Auto Insurance: cars, motorized vehicles, and motorcycles insurance- Health & Life Insurance: health insurance, life insurance, disability insurance, and similar transactions.- Other: transactions related to insurance that do not fit in any of the above subcategories. | Outflow Inflow |
Investments & Savings | - Savings: money invested in savings accounts.- Fixed income: investments in fixed income securities such as bonds.- Equity: investments in stocks or shares of companies.- Investment Funds: investments in mutual funds, index funds, or exchange-traded funds (ETFs).- Derivatives: investments in financial contracts derived from an underlying asset, such as options or futures.- Cryptocurrencies: investments in digital assets such as Bitcoin or Ethereum.- Other: transactions related to investments & savings that do not fit in any of the above subcategories. | Outflow Inflow |
Online Platforms & Leisure | -Apps, Software and Cloud Services: purchases of apps, software, or cloud services.- Events, Parks and Museums: purchases and long-term memberships at sporting events, music venues, concerts, museums, zoos, and amusement parks.- Gambling: gambling, casinos, government, and sports betting.- Gaming: digital and in-person video game purchases and subscriptions.- Lottery: transactions related to lottery games.- Movie & Video: In-home movie streaming services, movie theaters, and video rentals.- Music & Audio: digital and in-person music purchases (including music streaming services, podcast subscriptions, and record stores).- Other: transactions related to online platforms & leisure that do not fit in any of the above subcategories. | Outflow Inflow |
Personal Shopping | - Books & News: bookstores, and newsstands, including magazines and newspaper subscriptions.- Clothing & Accessories: apparel, shoes, jewelry, thrift / vintage stores, and subscription boxes like Stitch Fix.- Department Store: large shops stocking many varieties of goods in different departments.- Electronics: purchases of electronic devices or gadgets.- E-commerce: multi-purpose e-commerce platforms such as Amazon and eBay.- Gifts: photo, gifts, gift cards, and floral stores.- Office Supplies: office goods and printing stores.- Pet Supplies: purchases of pet food, toys, or accessories.- Other: transactions related to personal shopping that do not fit in any of the above subcategories. | Outflow Inflow |
Taxes | - Auto Tax & Fees: vehicle taxes and fees, such as registration and licensing fees.- Donation: charitable donations or contributions.- Government Fees: payments of fees related to government services or licenses, such as driving licenses, passport renewal, immigration services, and bail and bond payments.- Income Tax: payments for income taxes or estimated tax payments.- Real Estate Tax & Fees: payments of property taxes or fees related to real estate ownership.- Tax Return: refunds from the government.- Other: tax-related transactions not falling under any of the above categories. | Outflow Inflow |
Transfers | N/A - generic transfers with another account, including TED, DOC, PIX in Brazil, wire, and ACH transactions. | Outflow Inflow |
Transport & Travel | - Accommodation: hotels, motels, and hosted accommodations.- Auto Expenses: oil changes, car washes, repairs, tires, towing, auto parts, and similar expenses.- Auto Rental: car rentals, charter buses, vans, scooters, and moving trucks as well as non-motorized vehicles.- Flights: airline airfare, baggage fees, and related expenses.- Gas: gas station purchases, such as gasoline, fuel, or petrol refueling.- Mileage Programs: Reward programs offered by airlines and other travel companies.- Parking & Tolls: tolls for highways and bridges and parking (including long-term vehicle storage).- Public Transit: public transportation, including rail and train, buses, metro, and ferry.- Taxis & Rideshares: taxi, ride share, and limousine services.- Other: transactions related to transport & travel that do not fit in any of the above subcategories. | Outflow Inflow |
Unknown* | N/A - transactions with descriptions that are indecipherable, illegible, empty, or only numbers. | Outflow Inflow |
Withdrawal & ATM | N/A - money withdrawal in ATM machines. | Outflow |
* For clients not using our Transaction Categorization product, we return null instead.
Bills
This resource is only applicable for OFDA credit card accounts.
Our Bills resource provides you with information regarding the credit card bill associated with an OFDA credit card account.
For each bill, you receive:
- the total amount of the bill
- the due date for the bill to be paid
- any fees and charges associated with the bill
- the payments made to pay off the bill
We offer the following methods when it comes to interacting with Bills:
Updated 5 months ago