Consultar saque
/v1/withdrawals/{id}Devolve o saque. PROCESSING cobre payout com desfecho desconhecido até a reconciliação; o motivo interno de rejeição nunca sai, só failure.code.
X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).
kodanoOAuth payouts:withdrawals:readAuthorizationBearer <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: payouts:withdrawals:read
id*stringId do saque (wdr_…).
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}$X-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}$Saque.
application/json- response
id*string^wdr_status*stringTransições não monotônicas: FAILED pode virar COMPLETED ou voltar a REQUESTED.
"REQUESTED""PROCESSING""COMPLETED""FAILED"amount*integercurrency*"BRL"Único valor na v1.
"BRL"fee*integerCobrada por cima; 0 em saque legado.
totalAmount*integeramount + fee: o que sai do saldo.
netAmount*integerO que chega ao destino (= amount).
method*stringTED só leitura (saques antigos do portal).
"PIX_KEY""BANK_ACCOUNT""TED"destination*failure*|nullcreatedVia?string"API""PORTAL""BACKOFFICE""ONBOARDING"curl -X GET 'https://api.sandbox.kodano.com.br/v1/withdrawals/string' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "wdr_0192f3b0c4d17e8a9b2f5c6d7e8f9a0b", "status": "PROCESSING", "amount": 150000, "currency": "BRL", "fee": 150, "totalAmount": 150150, "netAmount": 150000, "method": "PIX_KEY", "destination": { "type": "PIX_KEY", "id": "pxk_0192f3a2b7c84d1e9f0a1b2c3d4e5f60" }, "failure": null, "createdVia": "API"}