Banking aggregation (Colombia)
Our banking aggregation product for Colombia lets you access account, owner, and transaction data to get a comprehensive view of your end user.We refer to links created with banking institutions (such as Bancolombia) as banking links.
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. |
Updated 2 months ago