v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Exchanges

List exchanges

{% admonition type="warning" name="Coming Soon" %} This endpoint is currently undergoing development. As such, minor changes or bugs may occur. If you encounter any issues, please contact your Belvo representative. {% /admonition %}

▶️ Usage

With the List Exchanges method, you can:

[Required] List exchanges related to a specific link.id (using the link query parameter).
Get the details of a specific exchange.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.

get/api/br/exchanges/

Query parameters

linkstring uuid required

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

The link.id you want to filter by.

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"
]

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 - Exchanges 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": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "collected_at": "2022-02-09T08:45:50.406032Z",
      "operation_identifier": "92792126019929240",
      "operation_number": "393874649456",
      "operation_type": "COMPRA",
      "operation_requested_at": "2023-03-07T08:30:00Z",
      "authorized_institution_identifier": 11225860000140,
      "authorized_institution_name": "AGENCIA CORRETORA",
      "intermediary_institution_identifier": 11225860000140,
      "intermediary_institution_name": "AGENCIA CORRETORA",
      "operation_due_date": "2018-02-15",
      "local_operation_tax_amount": 1.3,
      "local_operation_tax_currency": "BRL",
      "local_operation_value_amount": 1000.04,
      "local_operation_value_currency": "BRL",
      "foreign_operation_value_amount": 1000.04,
      "foreign_operation_value_currency": "USD",
      "operation_outstanding_balance_amount": 1000.04,
      "operation_outstanding_balance_currency": "USD",
      "tev_amount_amount": 1000.000004,
      "tev_amount_currency": "BRL",
      "local_currency_advance_percentage": 0.12,
      "settlement_method": "CARTA_CREDITO_A_PRAZO",
      "operation_category_code": "90302"
    }
  ]
}