# Listar exchanges

{% admonition type="warning" name="Em Breve" %}
  Este endpoint está atualmente em desenvolvimento. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
{% /admonition %}

## ▶️ Uso

Com o método List Exchanges, você pode:
  
  1. [Obrigatório] Listar exchanges relacionadas a um link.id específico (usando o parâmetro de consulta link).
  2. Obter os detalhes de um exchange.id específico (usando o parâmetro de consulta id).

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, veja nosso artigo Dicas de Paginação.

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

## Query parameters:

  - `link` (string, required)
    O link.id pelo qual você deseja filtrar.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `link__in` (array)
    Retorne resultados apenas para esses link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

  - `collected_at` (string)
    Retorne itens que foram recuperados da instituição nesta data (YYYY-MM-DD ou timestamp completo ISO-8601).
    Example: "2022-05-01"

  - `collected_at__gt` (string)
    Retorne itens que foram recuperados da instituição após esta data (YYYY-MM-DD ou timestamp completo ISO-8601).
    Example: "2022-05-05"

  - `collected_at__gte` (string)
    Retorne itens que foram recuperados da instituição após ou nesta data (YYYY-MM-DD ou timestamp completo ISO-8601).
    Example: "2022-05-04"

  - `collected_at__lt` (string)
    Retorne itens que foram recuperados da instituição antes desta data (YYYY-MM-DD ou timestamp completo ISO-8601).
    Example: "2022-04-01"

  - `collected_at__lte` (string)
    Retorne itens que foram recuperados da instituição antes ou nesta data (YYYY-MM-DD ou timestamp completo ISO-8601).
    Example: "2022-03-30"

  - `collected_at__range` (array)
    Retorne itens que foram recuperados da instituição entre duas datas (YYYY-MM-DD ou timestamp completo ISO-8601). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Um array de objetos de exchange.

  - `results.id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.link` (string,null, required)
    O link.id ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `results.created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.operation_identifier` (string, required)
    O identificador único da rede para a operação de troca.
    Example: "92792126019929240"

  - `results.operation_number` (string,null)
    O número de registro da operação de 12 dígitos do Banco Central do Brasil (Bacen). Isso pode ser null se a operação ainda não tiver sido registrada.
    Example: "393874649456"

  - `results.operation_type` (string, required)
    O tipo de operação de câmbio.

Retornamos um dos seguintes valores do enum:
  - COMPRA - Compra (o cliente está comprando moeda estrangeira)
  - VENDA - Venda (o cliente está vendendo moeda estrangeira)
    Enum: "COMPRA", "VENDA"

  - `results.operation_requested_at` (string, required)
    O carimbo de data e hora ISO-8601 quando a operação de câmbio foi contratada.
    Example: "2023-03-07T08:30:00Z"

  - `results.authorized_institution_identifier` (integer, required)
    O CNPJ da instituição autorizada a realizar a operação.
    Example: 11225860000140

  - `results.authorized_institution_name` (string, required)
    O nome da instituição autorizada.
    Example: "AGENCIA CORRETORA"

  - `results.intermediary_institution_identifier` (integer,null)
    O CNPJ da instituição intermediária, se uma foi utilizada.
    Example: 11225860000140

  - `results.intermediary_institution_name` (string,null)
    O nome da instituição intermediária. Deve estar presente se intermediary_institution_identifier estiver disponível.
    Example: "AGENCIA CORRETORA"

  - `results.operation_due_date` (string, required)
    A data de liquidação atualmente agendada para a operação, no formato YYYY-MM-DD.

> Nota: Este campo é atualizado se houver alterações na operação de câmbio.
    Example: "2018-02-15"

  - `results.local_operation_tax_amount` (number, required)
    A taxa de câmbio aplicada à operação.
    Example: 1.3

  - `results.local_operation_tax_currency` (string, required)
    O código de moeda de três letras (ISO-4217) para a taxa de câmbio.
    Example: "BRL"

  - `results.local_operation_value_amount` (number, required)
    O valor total da operação em moeda local.
    Example: 1000.04

  - `results.local_operation_value_currency` (string, required)
    O código de moeda de três letras (ISO-4217) para a moeda local.
    Example: "BRL"

  - `results.foreign_operation_value_amount` (number, required)
    O valor total da operação na moeda estrangeira.
    Example: 1000.04

  - `results.foreign_operation_value_currency` (string, required)
    O código de moeda de três letras (ISO-4217) para a moeda estrangeira.
    Example: "USD"

  - `results.operation_outstanding_balance_amount` (number,null)
    O saldo pendente a ser liquidado, na moeda estrangeira. No caso de a operação de câmbio estar programada para ser liquidada dentro de dois dias a partir de operation_requested_at, esse valor pode ser null.
    Example: 1000.04

  - `results.operation_outstanding_balance_currency` (string,null)
    A moeda do saldo devedor. Obrigatório se operation_outstanding_balance_amount não for null.
    Example: "USD"

  - `results.tev_amount_amount` (number,null)
    O "All-in Rate" (Valor Efetivo Total/Custo Efetivo Total), que representa o custo total da operação. Obrigatório quando a operação está programada para ser liquidada dentro de dois dias a partir de operation_requested_at e não excede $100,000 USD.
    Example: 1000.000004

  - `results.tev_amount_currency` (string,null)
    A moeda do VET (sempre BRL). Obrigatório se tev_amount_amount não for null.
    Example: "BRL"

  - `results.local_currency_advance_percentage` (number,null)
    A porcentagem do valor em moeda estrangeira que foi concedida ao cliente antecipadamente. No caso de a operação de câmbio estar programada para ser liquidada dentro de dois dias a partir de operation_requested_at, esse valor pode ser null.
    Example: 0.12

  - `results.settlement_method` (string,null, required)
    O método de entrega para a moeda estrangeira.

Retornamos um dos seguintes valores do enum:
  - CARTA_CREDITO_A_VISTA (Código 10) - Carta de crédito à vista
  - CARTA_CREDITO_A_PRAZO (Código 15) - Carta de crédito a prazo
  - CONTA_DEPOSITO (Código 20) - Conta de depósito
  - CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS (Código 21) - Conta de depósito em moeda estrangeira no país
  - CONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR (Código 22) - Conta de depósito do exportador mantida no exterior
  - CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR (Código 23) - Conta de depósito ou pagamento ao exportador em instituição no exterior
  - CONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS (Código 25) - Convênio de pagamentos e créditos recíprocos
  - CHEQUE (Código 30) - Cheque
  - ESPECIE_CHEQUES_VIAGEM (Código 50) - Espécie ou cheques de viagem
  - CARTAO_PREPAGO (Código 55) - Cartão pré-pago
  - TELETRANSMISSAO (Código 65) - Transferência eletrônica
  - TITULOS_VALORES (Código 75) - Títulos/valores mobiliários
  - SIMBOLICA (Código 90) - Simbólica
  - SEM_MOVIMENTACAO_VALORES (Código 91) - Sem movimentação de valores
  - DEMAIS (Código 99) - Outros
  - OUTRO_NAO_MAPEADO_OFB - Outro não mapeado pelo Open Finance Brasil
  - 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)
    O código de 5 dígitos do Banco Central que classifica a "natureza" da operação.

Este código deve estar em conformidade com os códigos de natureza referenciados na Resolução 277 ou na Circular 3690, conforme aplicável ao contrato de câmbio.
    Example: "90302"

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - 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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"