Criar operação de câmbio
/v1/fx/operationsCria a operação a partir de uma cotação e de uma conta de destino, e devolve o Pix que o pagador deve pagar.
- Os valores da resposta são os vinculantes: podem diferir da cotação (
repricedFromQuote: true). Mostre-os ao pagador antes de ele pagar. paymentInstructions.pixCopyPasteé o Pix copia e cola; gere o QR Code no seu lado. O pagamento vence empaymentInstructions.expiresAt.authorization.acceptedprecisa sertrueetermsVersionprecisa ser a versão vigente dos termos do câmbio à vista (global-spot-2026-10). Sua aplicação responde por colher o aceite de quem autoriza a transferência.- Resultado ambíguo na Kodano → 202 com
status: UNKNOWN. ConsulteGET /v1/fx/operations/{id}; nunca repita o POST com outraIdempotency-Key. - Cotação vencida → 410
FX.QUOTE_EXPIRED; conta de destino inativa ou incompatível com o rail → 422FX.PAYOUT_ACCOUNT_INVALID. - Repetir a mesma chave com o mesmo corpo devolve a resposta original (
X-Idempotent-Replay: true). - Merchant sem câmbio habilitado → 422
FX.NOT_ENABLED. - Sem o escopo exigido → 403
AUTH.ENTITLEMENT_MISSING.
kodanoOAuth fx:operations:writeAuthorizationBearer <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:write
X-Merchant-Id*stringMerchant 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.
^mrc_[0-9a-f]{32}$Idempotency-Key*stringUUID, 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.
uuidX-Correlation-Id?stringOpcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.
^[A-Za-z0-9._-]{1,64}$application/json- body
quoteId*string^fxq_[0-9a-f]{32}$payoutAccountId*string^fxa_[0-9a-f]{32}$customerReference?|Rótulo livre seu, até 64 caracteres, devolvido tal qual e aceito como filtro da lista. Não coloque dado pessoal.
authorization*Operação criada, aguardando o pagamento do Pix.
application/json- response
id*string^fxo_[0-9a-f]{32}$type*"SPOT"Câmbio à vista. Único valor hoje.
"SPOT"status*FxOperationStatusUNKNOWN: a Kodano ainda não confirmou a criação. AWAITING_PAYMENT: Pix à espera do pagamento. PAYMENT_RECEIVED, CONVERTING, PAYOUT_IN_PROGRESS: em andamento. SETTLED: dólar entregue (terminal). EXPIRED: Pix não pago no prazo (terminal). FAILED: falha sem dinheiro recebido (terminal). ACTION_REQUIRED: pagamento recebido sem entrega, a Kodano abre a devolução. REFUND_PENDING, REFUNDED (terminal), REFUND_FAILED: devolução.
"UNKNOWN""AWAITING_PAYMENT""PAYMENT_RECEIVED""CONVERTING""PAYOUT_IN_PROGRESS""SETTLED""EXPIRED""FAILED""ACTION_REQUIRED""REFUND_PENDING""REFUNDED""REFUND_FAILED"direction*"BRL_TO_USD"Do real para o dólar. Única direção hoje.
"BRL_TO_USD"rate*|Reais por dólar da operação; nulo em UNKNOWN.
payin*|nullpayout*|nullfees*array<>repricedFromQuote*booleantrue quando os valores da operação diferem da cotação.
payoutAccount*|nullcustomerReference*string|nullpaymentInstructions*|Presente enquanto a operação espera o pagamento (AWAITING_PAYMENT); nulo depois.
timeline*array<>supportReference*stringCódigo curto para falar com o suporte da Kodano.
receiptAvailable*booleancreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/fx/operations' \ -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 '{ "quoteId": "fxq_0192f4a1c3d24e5f8a9b0c1d2e3f4a5b", "payoutAccountId": "fxa_0192f4a0b2c14d3e7f8a9b0c1d2e3f4a", "customerReference": "pedido-8841", "authorization": { "accepted": true, "termsVersion": "global-spot-2026-10" }}'{ "id": "fxo_0192f4a2d4e35f6a9b0c1d2e3f4a5b6c", "type": "SPOT", "status": "AWAITING_PAYMENT", "direction": "BRL_TO_USD", "rate": "5.2400", "payin": { "amount": 500260, "currency": "BRL" }, "payout": { "amount": 95412, "currency": "USD" }, "fees": [ { "type": "COVER_FEE", "rail": "ACH", "amount": { "amount": 262, "currency": "BRL" }, "reference": { "amount": 50, "currency": "USD" } } ], "repricedFromQuote": true, "payoutAccount": { "id": "fxa_0192f4a0b2c14d3e7f8a9b0c1d2e3f4a", "label": "Fornecedor EUA · ACH · ••••0288", "rail": "ACH" }, "customerReference": "pedido-8841", "paymentInstructions": { "rail": "PIX", "pixCopyPaste": "00020126580014br.gov.bcb.pix0136...", "amount": { "amount": 500260, "currency": "BRL" }, "expiresAt": "2026-11-02T15:05:30Z" }, "timeline": [ { "status": "AWAITING_PAYMENT", "at": "2026-11-02T15:00:30Z" } ], "supportReference": "GA-7K2M9Q", "receiptAvailable": false, "createdAt": "2026-11-02T15:00:30Z", "updatedAt": "2026-11-02T15:00:30Z"}