Voltar ao site
Câmbio

Criar cotação

POST/v1/fx/quotes

Cotação com o rail de recebimento escolhido, a tarifa do rail e o total a pagar. É gravada e vale até expiresAt.

  • indicative é sempre true no câmbio à vista: o valor que vale é o da operação (POST /v1/fx/operations), que pode reprecificar. Não apresente a cotação como taxa garantida.
  • payoutRail: ACH, WIRE, SWIFT ou SEPA. Rail que a direção não aceita → 422 FX.RAIL_NOT_SUPPORTED.
  • A rate já inclui o spread da Kodano, definido nas taxas da loja ou, quando a loja não tem taxa própria, na taxa padrão da plataforma. Não há linha de spread à parte. A tarifa do rail (COVER_FEE) aparece em fees.
  • Merchant sem câmbio habilitado → 422 FX.NOT_ENABLED.
  • Sem o escopo exigido → 403 AUTH.ENTITLEMENT_MISSING.

Authorization

kodanoOAuth fx:quotes:write
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:quotes:write

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}$
Idempotency-Key*string

UUID, retido por 24 h a partir da primeira chamada. Escopo: (tenant, merchant, rota-template, chave). Mesma chave e mesmo corpo → resposta original (2xx ou 4xx) com X-Idempotent-Replay: true; corpo ou path concreto diferente → 409 IDEMPOTENCY.CONFLICT; em execução ou desfecho desconhecido → 409 IDEMPOTENCY.IN_PROGRESS com resourceId e Retry-After: 2. Ausente ou não-UUID → 422 IDEMPOTENCY.KEY_REQUIRED.

Formatuuid
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}$

Request Body

application/json
  1. body
product*"SPOT"

Câmbio à vista. Único valor hoje.

Value in"SPOT"
direction*"BRL_TO_USD"

Do real para o dólar. Única direção hoje.

Value in"BRL_TO_USD"
amount*
amountSide*string
Value in"PAYIN""PAYOUT"
payoutRail*FxRail

Meio de entrega do dólar na conta de destino.

Value in"ACH""WIRE""SWIFT""SEPA"

Response Body

Cotação criada.

application/json
  1. response
id*string
Match^fxq_[0-9a-f]{32}$
status*"QUOTED"
Value in"QUOTED"
product*"SPOT"

Câmbio à vista. Único valor hoje.

Value in"SPOT"
direction*"BRL_TO_USD"

Do real para o dólar. Única direção hoje.

Value in"BRL_TO_USD"
payoutRail*FxRail

Meio de entrega do dólar na conta de destino.

Value in"ACH""WIRE""SWIFT""SEPA"
rate*string

Reais por dólar, decimal em string.

payin*

payin mais as tarifas em reais: o que o pagador paga.

payout*

payin mais as tarifas em reais: o que o pagador paga.

fees*array<>
totalPayin*

payin mais as tarifas em reais: o que o pagador paga.

indicative*true
Value intrue
expiresAt*string
Formatdate-time
Example Request
curl -X POST 'https://api.sandbox.kodano.com.br/v1/fx/quotes' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'Idempotency-Key: 4b2e8c1a-9d7f-4e3b-a6c5-0f1e2d3c4b5a' \  -H 'X-Correlation-Id: erp-7f3a-0010' \  -H 'Content-Type: application/json' \  -d '{  "product": "SPOT",  "direction": "BRL_TO_USD",  "amount": {    "amount": 500000,    "currency": "BRL"  },  "amountSide": "PAYIN",  "payoutRail": "ACH"}'
Example Response
{  "id": "fxq_0192f4a1c3d24e5f8a9b0c1d2e3f4a5b",  "status": "QUOTED",  "product": "SPOT",  "direction": "BRL_TO_USD",  "payoutRail": "ACH",  "rate": "5.2392",  "payin": {    "amount": 500000,    "currency": "BRL"  },  "payout": {    "amount": 95434,    "currency": "USD"  },  "fees": [    {      "type": "COVER_FEE",      "rail": "ACH",      "amount": {        "amount": 262,        "currency": "BRL"      },      "reference": {        "amount": 50,        "currency": "USD"      }    }  ],  "totalPayin": {    "amount": 500262,    "currency": "BRL"  },  "indicative": true,  "expiresAt": "2026-11-02T15:10:00Z"}