Listar liquidações
/v1/settlementsUm lote por data de liquidação, em ordem decrescente de data, sem items. Agenda futura sai SCHEDULED; data chegada e ainda sem liquidação sai PROCESSING. O sync é diário: o status pode atrasar até 24 h.
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
from?stringData de liquidação, inclusiva; padrão hoje − 30.
dateto?stringData de liquidação, inclusiva; padrão hoje + 30; janela máxima de 93 dias.
datestatus?stringStatus do lote.
"SCHEDULED""PROCESSING""SETTLED""FAILED""REVERSED"limit?integerTamanho da página, 1–100; fora → 422 VALIDATION.FAILED.
1 <= value <= 10020cursor?stringnextCursor da página anterior, com os mesmos filtros e o mesmo limit. Adulterado, de outra lista, de outro merchant ou com filtros diferentes → 422 CURSOR.INVALID.
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}$Página de liquidações.
application/json- response
data*array<>hasMore*booleanHá página seguinte.
nextCursor*|Cursor opaco e assinado da página seguinte; null quando hasMore é false.
curl -X GET 'https://api.sandbox.kodano.com.br/v1/settlements' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "stl_202610179c4e2a7f01b3d58e6a2c4f17", "status": "SCHEDULED", "settlementDate": "2026-10-17", "currency": "BRL", "transactionCount": 12, "grossAmount": 250000, "feesAmount": 7250, "netAmount": 242750, "settledAt": null }, { "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" } ], "hasMore": false, "nextCursor": null}