Voltar ao site
Câmbio

Listar operações de câmbio

GET/v1/fx/operations

Operações do merchant, da mais nova para a mais antiga.

  • Sem o escopo exigido → 403 AUTH.ENTITLEMENT_MISSING.

Authorization

kodanoOAuth fx:operations:read
headerAuthorizationBearer <token>

Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.

  • Sandbox: https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token
  • Produção: https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token

Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.

O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.

Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.

Scope: fx:operations:read

Query Parameters

limit?integer

Tamanho da página, 1–100; fora → 422 VALIDATION.FAILED.

Range1 <= value <= 100
Default20
cursor?string

nextCursor da página anterior, com os mesmos filtros e o mesmo limit. Adulterado, de outra lista, de outro merchant ou com filtros diferentes → 422 CURSOR.INVALID.

status?array<>

Filtra por status; repita o parâmetro para mais de um.

direction?"BRL_TO_USD"

Filtra pela direção.

Value in"BRL_TO_USD"
createdFrom?string

Início inclusivo [from, to).

Formatdate-time
createdTo?string

Fim exclusivo; from > to → VALIDATION.RANGE.

Formatdate-time
customerReference?string

Referência exata informada na criação.

Lengthlength <= 64

Header Parameters

X-Merchant-Id*string

Merchant da operação (mrc_ + Guid sem hífens, minúsculo). Obrigatório com credencial de organização (ausente → 400 MERCHANT.HEADER_REQUIRED); com credencial de merchant é opcional (ausente = o próprio merchant). Malformado, repetido, inexistente ou de outro tenant → 403 MERCHANT.FORBIDDEN (nunca 404). Vazio = ausente.

Match^mrc_[0-9a-f]{32}$
X-Correlation-Id?string

Opcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.

Match^[A-Za-z0-9._-]{1,64}$

Response Body

Página de operações.

application/json
  1. response
data*array<>
hasMore*boolean
nextCursor*string|null
Example Request
curl -X GET 'https://api.sandbox.kodano.com.br/v1/fx/operations' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'X-Correlation-Id: erp-7f3a-0010'
Example Response
{  "data": [    {      "id": "fxo_0192f4a2d4e35f6a9b0c1d2e3f4a5b6c",      "type": "SPOT",      "status": "SETTLED",      "direction": "BRL_TO_USD",      "rate": "5.2400",      "payin": {        "amount": 500260,        "currency": "BRL"      },      "payout": {        "amount": 95412,        "currency": "USD"      },      "customerReference": "pedido-8841",      "createdAt": "2026-11-02T15:00:30Z",      "updatedAt": "2026-11-03T14:00:00Z"    }  ],  "hasMore": false,  "nextCursor": null}