Consultar liquidação
/v1/settlements/{id}Lote com items paginados por itemsLimit/itemsCursor. Itens FAILED e REVERSED aparecem em items mas ficam fora dos totais. O id embute o hash do merchant: com outro X-Merchant-Id responde 404. O id do evento settlement.closed abre nesta rota.
X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).
kodanoOAuth receivables:settlements: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: receivables:settlements:read
id*stringId da liquidação (stl_ + yyyyMMdd + 24 hex).
itemsLimit?integerTamanho da página de itens.
1 <= value <= 10020itemsCursor?stringitems.nextCursor da chamada anterior.
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}$Liquidação com itens.
application/json- response
id*stringstl_ + yyyyMMdd + 24 hex.
^stl_[0-9]{8}[0-9a-f]{24}$status*SettlementStatus"SCHEDULED""PROCESSING""SETTLED""FAILED""REVERSED"settlementDate*stringdatecurrency*"BRL"Único valor na v1.
"BRL"transactionCount*integergrossAmount*integerfeesAmount*integergrossAmount − netAmount.
netAmount*integersettledAt*|Só em SETTLED.
date-timeitems*curl -X GET 'https://api.sandbox.kodano.com.br/v1/settlements/string' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "stl_2026101501a33e1fc42bb5898fe70dbb", "status": "SETTLED", "settlementDate": "2026-10-15", "currency": "BRL", "transactionCount": 3, "grossAmount": 99000, "feesAmount": 2871, "netAmount": 96129, "settledAt": "2026-10-15T00:00:00Z", "items": { "data": [ { "paymentId": "pay_8f2c1e9a", "method": "CREDIT_CARD", "installment": 2, "status": "SETTLED", "anticipated": false, "grossAmount": 33000, "feesAmount": 957, "netAmount": 32043 }, { "paymentId": "pay_5d1a7e3b", "method": "CREDIT_CARD", "installment": 1, "status": "SETTLED", "anticipated": true, "grossAmount": 33000, "feesAmount": 957, "netAmount": 32043 } ], "hasMore": true, "nextCursor": "eyJtIjoiQ1JFRElUX0NBUkQiLCJ0IjoxMjM0NSwiaSI6MSwiciI6ZmFsc2V9.Lr8vT2" }}