Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Balances

List balances

▶️ Usage

With the List Balances method, you can:

  1. [Required] List balances related to a specific link.id (using the link query parameter).
  2. [Highly Recommended] List balances related to a specific link.id and account.id (using the link and account query parameters).
  3. Get the details of a specific balance.id (using the id query parameter).

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

🚨 Deprecated Fields

This resource may return deprecated fields. In the response documentation 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.

get/api/br/balances/

Query parameters

linkstring uuid required
Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The link.id you want to filter by.

accountstring uuid
Example:8848bd0c-9c7e-4f53-a732-ec896b11d4c4

The account.id you want to filter by.

ℹ️ We highly recommend adding either the link.id or the account.id filters in order to improve your performance.

idstring uuid
Example:24ccab1d-3a86-4136-a6eb-e04bf52b356f

Return information only for this resource id.

link__instring[]

Return results only for these link.ids.

[
  "5722d0ba-69d7-42dc-8ff5-33767b83c5d6"
]
account__instring[]

Return results only for these account.ids.

[
  "85b77707-90ef-46fd-9059-5a757f24247a"
]
id__instring[]

Return information for these resource ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]
page_sizeinteger
Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

pageinteger
Example:1

A page number within the paginated result set.

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

collected_atstring date
Example:2022-05-01

Return items that were retrieved from the institution on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__gtstring date
Example:2022-05-05

Return items that were retrieved from the institution after this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__gtestring date
Example:2022-05-04

Return items that were retrieved from the institution after or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__ltstring date
Example:2022-04-01

Return items that were retrieved from the institution before this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__ltestring date
Example:2022-03-30

Return items that were retrieved from the institution before or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

collected_at__rangestring[]

Return items that were retrieved from the institution between two dates (YYYY-MM-DD or full ISO-8601 timestamp). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]
created_atstring date
Example:2022-05-05

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

created_at__gtstring date
Example:2022-05-05

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

created_at__gtestring date
Example:2022-05-04

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

created_at__ltstring date
Example:2022-04-01

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

created_at__ltestring date
Example:2022-03-30

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]

Response

OK - Balances Retrieved

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": "0b94bdf9-3719-43a9-81e7-be95d2318595",
      "link": "0b94bdf9-3719-43a9-81e7-be95d2318595",
      "account_id": "c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321",
      "account_internal_identification": "92792126019929279212650822221989319252576",
      "collected_at": "2024-05-21T08:32:00Z",
      "created_at": "2024-05-21T08:32:00Z",
      "last_updated_at": "2021-05-21T08:30:00Z",
      "currency": "USD",
      "available": 1000.02,
      "blocked": 1000.02,
      "automatically_invested": 1000.02
    }
  ]
}