Cadastrar conta de destino
/v1/fx/payout-accountsCadastra a conta que recebe o dólar. A Kodano valida os dados antes de enviar (ABA com 9 dígitos, BIC com 8 ou 11, IBAN com dígito verificador).
- Informe os blocos do rail escolhido:
bank(ACH e WIRE),swiftcombeneficiaryAddressebankAddress(SWIFT) ousepa(SEPA). - A conta nasce
ACTIVE. SWIFT para terceiro nascePENDING_DOCUMENTaté você enviar o documento da operação emPOST /v1/fx/payout-accounts/{id}/documents. - Dado recusado → 422
FX.PAYOUT_ACCOUNT_VALIDATIONcomerrors[]por campo. Rail indisponível → 422FX.RAIL_NOT_AVAILABLE. - A resposta devolve a conta mascarada: o número completo nunca volta.
- Merchant sem câmbio habilitado → 422
FX.NOT_ENABLED. - Sem o escopo exigido → 403
AUTH.ENTITLEMENT_MISSING.
kodanoOAuth fx:payout-accounts: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:payout-accounts: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
rail*FxRailMeio de entrega do dólar na conta de destino.
"ACH""WIRE""SWIFT""SEPA"displayName*stringlength <= 80holder*bank?ACH e WIRE.
swift?SWIFT.
sepa?SEPA.
address?Endereço do beneficiário (SWIFT).
beneficiaryAddress?Endereço do beneficiário (SWIFT).
bankAddress?Endereço do banco (SWIFT).
Conta cadastrada.
application/json- response
id*string^fxa_[0-9a-f]{32}$displayName*stringrail*FxRailMeio de entrega do dólar na conta de destino.
"ACH""WIRE""SWIFT""SEPA"currency*"USD""USD"holderName*stringbankName*string|nullmaskedAccount*stringSó os últimos 4 dígitos.
label*stringstatus*FxPayoutAccountStatus"ACTIVE""PENDING_DOCUMENT""INACTIVE"createdAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/fx/payout-accounts' \ -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 '{ "rail": "ACH", "displayName": "Fornecedor EUA", "holder": { "name": "Global Trade LLC", "accountClass": "BUSINESS", "relationship": "VENDOR_OR_SUPPLIER", "businessIndustryNaics": "522320" }, "bank": { "name": "Chase", "routingNumber": "021000021", "accountNumber": 123456789, "accountType": "CHECKING" }, "address": { "line1": "100 Main St", "city": "New York", "stateProvinceRegion": "NY", "country": "US", "postalCode": "10001" }}'{ "id": "fxa_0192f4a0b2c14d3e7f8a9b0c1d2e3f4a", "displayName": "Fornecedor EUA", "rail": "ACH", "currency": "USD", "holderName": "Global Trade LLC", "bankName": "Chase", "maskedAccount": "••••0288", "label": "Fornecedor EUA · ACH · ••••0288", "status": "ACTIVE", "createdAt": "2026-11-02T14:50:00Z"}