Consulta de Cotações do Dólar
Esses endpoints têm como objetivo fornecer acesso às cotações atualizadas do dólar, utilizando como fonte oficial a API do Banco Central do Brasil (BACEN). Foram implementadas duas rotas que permitem a consulta dos valores do dólar em diferentes formatos, facilitando a integração com sistemas.
Listar cotações referente a uma data
Este endpoint permite listar as cotações do dólar referentes a uma data específica.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- É necessário estar autenticado pelo fluxo MTLS e informar a data para a qual se deseja consultar a cotação.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/network-authorization/fees/dolar-rates?date={{date}}curl -X 'GET' \
'https://api-mtls.sandbox.bankly.com.br/network-authorization/fees/dolar-rates?date={{date}}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {{Token}}'Autorização
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
authorizer.fees.dollar.read | Concede acesso à consulta da tarifa de dólar consultada no BACEN e aplicada nos serviços de transações bandeiradas da Bankly. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
date | string | Obrigatório. Data solicitada. | YYYY-MM-DD |
Resposta (Response)
Os status 200 indica que a solicitação foi aceita e o livro está sendo adicionado ao catálogo.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
feeAmount | number | Valor da cotação | decimal (18,4) |
feeDate | number | Data da cotação | — |
correlationId | string | Id de correlação da cotação | — |
[
{
"feeAmount": 5.6874,
"feeDate": "2025-04-23T18:30:07-03:00",
"correlationId": "7efe87e8-bbcf-42d5-892d-1220431860ae"
}
]Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | INVALID_PARAMETER | The field title must not be empty. | O campo date é obrigatório. |
| 500 | INTERNAL_SERVER_ERROR | Internal Server Error. | Erro genérico da API. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Listar cotações referente ao período informado
Este endpoint permite listar as cotações do dólar referentes ao período informado.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- É necessário estar autenticado pelo fluxo MTLS e informar a data para a qual se deseja consultar a cotação.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/network-authorization/fees/dolar-rates/date-range?startDate={{startDate}}&endDate={{endDate}}&pageSize={{pageSize}}&page={{page}}curl -X 'GET' \
'https://api-mtls.sandbox.bankly.com.br/network-authorization/fees/dolar-rates/date-range?startDate={{startDate}}&endDate={{endDate}}&pageSize={{pageSize}}&page={{page}}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {{token}}'Autorização
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
authorizer.fees.dollar.read | Concede acesso à consulta da tarifa de dólar consultada no BACEN e aplicada nos serviços de transações bandeiradas da Bankly. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
startDate | string | Obrigatório. Inicio do período solicitado. | YYYY-MM-DD |
endDate | string | Obrigatório. Fim do período solicitado. | YYYY-MM-DD |
pageSize | int | Obrigatório. Quantidade limite de itens que serão retornados. | 0 até 9999999999 |
page | int | Obrigatório. Número da página a ser retornada. | 0 até 9999999999 |
Resposta (Response)
Os status 200 indica que a solicitação foi aceita e o livro está sendo adicionado ao catálogo.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Número máximo de caracteres |
|---|---|---|---|
pageSize | int | Quantidade limite de itens retornados. | 0 até 9999999999 |
page | int | Página retornada. | 1 até 9999999999 |
response | array of objects | Lista de cotações | — |
response[].feeAmount | number | Valor da cortação | decimal (18,4) |
response[].feeDate | string | Data da cotação | — |
response[].correlationId | string | Id de correlação da cotação | — |
{
"response": [
{
"feeAmount": 5.749,
"feeDate": "2025-04-22T18:30:02-03:00",
"correlationId": "94aa0ea7-e991-4b5c-98cf-f16ac7942922"
},
{
"feeAmount": 5.6874,
"feeDate": "2025-04-23T18:30:07-03:00",
"correlationId": "7efe87e8-bbcf-42d5-892d-1220431860ae"
}
],
"pageSize": 30,
"page": 1
}Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | INVALID_PARAMETER | The field title must not be empty. | O campo date é obrigatório. |
| 500 | INTERNAL_SERVER_ERROR | Internal Server Error. | Erro genérico da API. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Updated about 12 hours ago