Banking

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.

15741574

❗️

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 or investment 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.

Balances

Our Balances resource provides you with the financial status of an Link's account at a given time.

Use this resource to get information about a banking link's:

  • daily account balance over a period of time

📘

Savings accounts that do not have any associated transactions (for example, some poupança accounts in Brazil) will not contain accurate Balance information. We do not recommend using the Balance endpoint for these types of accounts.

Savings accounts vary from institution to institution, so we recommend that you first use our Retrieve transactions for a link request, adding the account in the request body, to see if the Savings account has any associated transactions.

We offer the following methods when it comes to interacting with Balances:

Endpoints

Method

Description

Retrieve

POST

Retrieve balances from a specific account or all accounts from a specific link. You can retrieve the balances at the end of the day for all accounts between two dates.

List

GET

List all existing balances in your Belvo account.

Resume

PATCH

Resume a Balance Retrieve session that was paused because an MFA token was required by the institution.

Detail

GET

Get the details of a specific balance.

Destroy

DELETE

Delete a specific balance from your Belvo account.

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.

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.

Transaction categorization

Using a combination of internal and external data sources, we provide a clean and standardized category for most transactions as well as additional data regarding the merchant involved in the transactions.

With this product, a category is automatically assigned to each transaction as soon as it is retrieved from the bank. We also extract and enrich data from transactions and provide you with a standardized version of the merchant’s name, logo, and website URL.

📘

Get Transaction categorization

If you opt in to enable Transaction categorization, just email our sales team at [email protected], and they'll get right to it 😎.

Here is the list of transaction categories we support:

Category

Example of transaction

Deposits

"DEPOSITO INTERBANCARIO"

Home & Life

"ELEKTRA MEXIC"

Food & Groceries

"OXXO CIPRESES"

Online Platforms & Leisure

"NETFLIX COM CR"

Transport & Travel

"UBER TRIP HELP.UBER.COM"

Personal Shopping

"LIVERPOOL POR INTERNET"

Taxes

"IVA COM MEMBRESIA"

Withdrawal & ATM

"RETIRO CAJERO AUTOMATICO"

Credits & Loans

"ABONO A CREDITO GLOBAL"

Bills & Utilities

"HT TELCEL 018008"

Investments & Savings

"ABONO INTERESES AHORROS"

Fees & Charges

"COMISION EMISION"

Income & Payments

"PAGO DE NOMINA"

Transfers

"SPEI RECIBIDOSTP"


Did this page help you?