# 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:
  
  1. [Required] List exchanges related to a specific link.id (using the link query parameter).
  2. 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 Filtering responses 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 Pagination Tips article.

Endpoint: GET /api/br/exchanges/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string, required)
    The link.id you want to filter by.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `id` (string)
    Return information only for this resource id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `link__in` (array)
    Return results only for these link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `id__in` (array)
    Return information for these resource ids.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `page_size` (integer)
    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).
    Example: 100

  - `page` (integer)
    A page number within the paginated result set.
    Example: 1

  - `omit` (string)
    Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

  - `fields` (string)
    Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

  - `collected_at` (string)
    Return items that were retrieved from the institution on this date (YYYY-MM-DD or full ISO-8601 timestamp).
    Example: "2022-05-01"

  - `collected_at__gt` (string)
    Return items that were retrieved from the institution after this date (YYYY-MM-DD or full ISO-8601 timestamp).
    Example: "2022-05-05"

  - `collected_at__gte` (string)
    Return items that were retrieved from the institution after or on this date (YYYY-MM-DD or full ISO-8601 timestamp).
    Example: "2022-05-04"

  - `collected_at__lt` (string)
    Return items that were retrieved from the institution before this date (YYYY-MM-DD or full ISO-8601 timestamp).
    Example: "2022-04-01"

  - `collected_at__lte` (string)
    Return items that were retrieved from the institution before or on this date (YYYY-MM-DD or full ISO-8601 timestamp).
    Example: "2022-03-30"

  - `collected_at__range` (array)
    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.
    Example: ["2022-01-01","2022-12-31"]

  - `created_at` (string)
    Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).
    Example: "2022-03-30"

  - `created_at__range` (array)
    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.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    The total number of results in your Belvo account.
    Example: 130

  - `next` (string,null)
    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).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    The URL to the previous page of results. If there is no previous page, the
value is null.

  - `results` (array)
    An array of exchange objects.

  - `results.id` (string, required)
    Belvo's unique identifier for the current item.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    The link.id the data belongs to.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.created_at` (string, required)
    The ISO-8601 timestamp of when the data point was created in Belvo's database.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.collected_at` (string, required)
    The ISO-8601 timestamp when the data point was collected.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.operation_identifier` (string, required)
    The network's unique identifier for the exchange operation.
    Example: "92792126019929240"

  - `results.operation_number` (string,null)
    The 12-digit operation registration number from the Brazil Central Bank (Bacen). This can be null if the operation has not yet been registered.
    Example: "393874649456"

  - `results.operation_type` (string, required)
    The type of exchange operation.

We return one of the following enum values:
  - COMPRA - Buy (client is buying foreign currency)
  - VENDA - Sell (client is selling foreign currency)
    Enum: "COMPRA", "VENDA"

  - `results.operation_requested_at` (string, required)
    The ISO-8601 timestamp when the exchange operation was contracted.
    Example: "2023-03-07T08:30:00Z"

  - `results.authorized_institution_identifier` (integer, required)
    The CNPJ of the institution authorized to conduct the operation.
    Example: 11225860000140

  - `results.authorized_institution_name` (string, required)
    The name of the authorized institution.
    Example: "AGENCIA CORRETORA"

  - `results.intermediary_institution_identifier` (integer,null)
    The CNPJ of the intermediary institution, if one was used.
    Example: 11225860000140

  - `results.intermediary_institution_name` (string,null)
    The name of the intermediary institution. Must be present if intermediary_institution_identifier is available.
    Example: "AGENCIA CORRETORA"

  - `results.operation_due_date` (string, required)
    The currently scheduled settlement date for the operation, in YYYY-MM-DD format. 

> Note: This field is updated if any changes are made to the exchange operation.
    Example: "2018-02-15"

  - `results.local_operation_tax_amount` (number, required)
    The exchange rate applied to the operation.
    Example: 1.3

  - `results.local_operation_tax_currency` (string, required)
    The three-letter currency code (ISO-4217) for the exchange rate.
    Example: "BRL"

  - `results.local_operation_value_amount` (number, required)
    The total value of the operation in local currency.
    Example: 1000.04

  - `results.local_operation_value_currency` (string, required)
    The three-letter currency code (ISO-4217) for the local currency.
    Example: "BRL"

  - `results.foreign_operation_value_amount` (number, required)
    The total value of the operation in the foreign currency.
    Example: 1000.04

  - `results.foreign_operation_value_currency` (string, required)
    The three-letter currency code (ISO-4217) for the foreign currency.
    Example: "USD"

  - `results.operation_outstanding_balance_amount` (number,null)
    The outstanding balance to be settled, in the foreign currency. In the case that the exchange operation is scheduled to be settled within two days of the operation_requested_at, this value can be null.
    Example: 1000.04

  - `results.operation_outstanding_balance_currency` (string,null)
    The currency of the outstanding balance. Required if operation_outstanding_balance_amount is not null.
    Example: "USD"

  - `results.tev_amount_amount` (number,null)
    The "All-in Rate" (Valor Efetivo Total/Total Effective Cost), representing the total cost of the operation. Required when the operation is scheduled to be settled within two days of the operation_requested_at and does not exceed $100,000 USD.
    Example: 1000.000004

  - `results.tev_amount_currency` (string,null)
    The currency of the VET (always BRL). Required if tev_amount_amount is not null.
    Example: "BRL"

  - `results.local_currency_advance_percentage` (number,null)
    The percentage of the foreign currency value that was granted to the client in advance. In the case that the exchange operation is scheduled to be settled within two days of the operation_requested_at, this value can be null.
    Example: 0.12

  - `results.settlement_method` (string,null, required)
    The method of delivery for the foreign currency.

We return one of the following enum values:
  - CARTA_CREDITO_A_VISTA (Code 10) - Sight letter of credit
  - CARTA_CREDITO_A_PRAZO (Code 15) - Term letter of credit
  - CONTA_DEPOSITO (Code 20) - Deposit account
  - CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS (Code 21) - Foreign currency deposit account in country
  - CONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR (Code 22) - Exporter's deposit account maintained abroad
  - CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR (Code 23) - Deposit account or payment to exporter at foreign institution
  - CONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS (Code 25) - Reciprocal payments and credits agreement
  - CHEQUE (Code 30) - Check
  - ESPECIE_CHEQUES_VIAGEM (Code 50) - Cash or traveler's checks
  - CARTAO_PREPAGO (Code 55) - Prepaid card
  - TELETRANSMISSAO (Code 65) - Wire transfer
  - TITULOS_VALORES (Code 75) - Securities/bonds
  - SIMBOLICA (Code 90) - Symbolic
  - SEM_MOVIMENTACAO_VALORES (Code 91) - No movement of funds
  - DEMAIS (Code 99) - Others
  - OUTRO_NAO_MAPEADO_OFB - Other not mapped by Open Finance Brazil
  - null
    Enum: "CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS", "CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR", "ESPECIE_CHEQUES_VIAGEM", "CARTAO_PREPAGO", "TELETRANSMISSAO", "SEM_MOVIMENTACAO_VALORES", "DEMAIS", "CARTA_CREDITO_A_VISTA", "CARTA_CREDITO_A_PRAZO", "CONTA_DEPOSITO", "CHEQUE", "TITULOS_VALORES", "SIMBOLICA", "CONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR", "CONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS", "OUTRO_NAO_MAPEADO_OFB", null

  - `results.operation_category_code` (string, required)
    The 5-digit Central Bank code that classifies the "nature" of the operation.

This code must comply with the nature codes referenced in Resolution 277 or Circular 3690, as applicable to the exchange contract.
    Example: "90302"

## Response 403 fields (application/json):

  - `code` (string)
    A unique error code (access_to_resource_denied) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    A short description of the error. 


For access_to_resource_denied errors, the description is:
  
  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    A unique error code (request_timeout) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors.
    Example: "request_timeout"

  - `message` (string)
    A short description of the error. 


For request_timeout errors, the description is:
  
  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    A unique error code (unexpected_error) that allows you to classify and handle the error programmatically.


ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors.
    Example: "unexpected_error"

  - `message` (string)
    A short description of the error. 


For unexpected_error errors, the description is:
  
  - Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    A 32-character unique ID of the request (matching a regex pattern of: [a-f0-9]{32}). Provide this ID when contacting the Belvo support team to accelerate investigations.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"