API de Câmbio

GET /baas/v1/open/dat/exchanges

Obtém a lista de operações de câmbio (compra e venda de moeda estrangeira) contratadas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Permission necessária: EXCHANGES_READ

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "operationId": "a7603c7c-d6b4-11ed-afa1-0242ac120002",
      "brandName": "Banco Câmbio",
      "companyCnpj": "50685362000135",
      "operationType": "COMPRA",
      "foreignCurrency": "USD"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data[].operationId: Identificador único da operação de câmbio na instituição transmissora. Até 100 caracteres.
• data[].brandName: Nome da marca reportada pelo participante no Open Finance. Até 80 caracteres.
• data[].companyCnpj: CNPJ completo da instituição responsável pela operação (sem máscara).
• data[].operationType: Tipo da operação de câmbio. Enum: COMPRA, VENDA.
• data[].foreignCurrency: Moeda estrangeira negociada, no padrão ISO-4217 (ex: USD).
• links.self: URI completa que gerou a resposta atual.
• links.first: URI da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
• links.next: URI da próxima página. Obrigatório quando não for a última página.
• links.last: URI da última página. Obrigatório quando não for a última página.
• meta.totalRecords: Número total de registros no resultado.
• meta.totalPages: Número total de páginas no resultado.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/exchanges/{operationId}

Obtém os dados de uma operação de câmbio específica identificada por operationId: tipo (compra/venda), moeda estrangeira, datas de contratação e liquidação, valores em moeda estrangeira e em reais e taxa de câmbio contratada.

Permission necessária: EXCHANGES_READ

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "operationId": "a7603c7c-d6b4-11ed-afa1-0242ac120002",
    "operationType": "COMPRA",
    "foreignCurrency": "USD",
    "operationDate": "2025-06-10",
    "dueDate": "2025-06-12",
    "foreignOperationValue": {
      "amount": "10500.00",
      "currency": "USD"
    },
    "localCurrencyOperationValue": {
      "amount": "53865.00",
      "currency": "BRL"
    },
    "operationRate": "5.130000"
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data.operationId: Identificador único da operação de câmbio na instituição transmissora. Até 100 caracteres.
• data.operationType: Tipo da operação de câmbio. Enum: COMPRA, VENDA.
• data.foreignCurrency: Moeda estrangeira negociada, no padrão ISO-4217 (ex: USD).
• data.operationDate: Data de contratação da operação, no formato ISO-8601 (AAAA-MM-DD).
• data.dueDate: Data de liquidação da operação, no formato ISO-8601 (AAAA-MM-DD).
• data.foreignOperationValue.amount: Valor da operação em moeda estrangeira. Com 2 a 4 casas decimais.
• data.foreignOperationValue.currency: Moeda estrangeira no padrão ISO-4217.
• data.localCurrencyOperationValue.amount: Valor da operação em moeda nacional (BRL). Com 2 a 4 casas decimais.
• data.localCurrencyOperationValue.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data.operationRate: Taxa de câmbio contratada, com 6 casas decimais (ex: 5.130000).
• links.self: URI completa que gerou a resposta atual.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/exchanges/{operationId}/events

Obtém o histórico de eventos da operação de câmbio identificada por operationId, como contratação, cancelamento, alteração de prazo e liquidação antecipada.

Permission necessária: EXCHANGES_READ

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "eventSequenceNumber": "1",
      "eventType": "CONTRATACAO",
      "eventDate": "2025-06-10",
      "foreignAmount": {
        "amount": "10500.00",
        "currency": "USD"
      },
      "localCurrencyAmount": {
        "amount": "53865.00",
        "currency": "BRL"
      },
      "operationRate": "5.130000"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data[].eventSequenceNumber: Identificador único do evento. Até 100 caracteres.
• data[].eventType: Tipo do evento. Enum: CONTRATACAO, CANCELAMENTO, ALTERACAO_PRAZO, LIQUIDACAO_ANTECIPADA, BAIXA_PROVISORIA, OUTROS.
• data[].eventDate: Data do evento, no formato ISO-8601 (AAAA-MM-DD).
• data[].foreignAmount.amount: Valor em moeda estrangeira no evento. Com 2 a 4 casas decimais.
• data[].foreignAmount.currency: Moeda estrangeira no padrão ISO-4217.
• data[].localCurrencyAmount.amount: Valor em moeda nacional (BRL) no evento. Com 2 a 4 casas decimais.
• data[].localCurrencyAmount.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data[].operationRate: Taxa de câmbio aplicada no evento, com 6 casas decimais (ex: 5.130000).
• links.self: URI completa que gerou a resposta atual.
• links.first: URI da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
• links.next: URI da próxima página. Obrigatório quando não for a última página.
• links.last: URI da última página. Obrigatório quando não for a última página.
• meta.totalRecords: Número total de registros no resultado.
• meta.totalPages: Número total de páginas no resultado.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.