Voltar ao site
Saldo e extrato

Consultar extrato

GET/v1/statement

Lançamentos da conta available da carteira default, em occurredAt decrescente; balanceAfter fecha com o saldo do treasury em toda página. Tarifas vêm somadas no lançamento (o saque sai num só WITHDRAWAL de totalAmount). type e category filtram depois do cálculo do saldo: a página pode vir menor que limit com hasMore: true.

X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).

Authorization

kodanoOAuth receivables:statement:read
headerAuthorizationBearer <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:statement:read

Query Parameters

from?string

Início inclusivo; padrão to − 30 dias.

Formatdate-time
to?string

Fim exclusivo; padrão agora; janela máxima de 93 dias.

Formatdate-time
type?string

Tipo do lançamento.

Value in"CREDIT""DEBIT"
category?string

Categoria.

Value in"PAYMENT""FEE""WITHDRAWAL""REFUND""CHARGEBACK""ADJUSTMENT"
limit?integer

Tamanho da página, 1–100; fora → 422 VALIDATION.FAILED.

Range1 <= value <= 100
Default20
cursor?string

nextCursor 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.

Header Parameters

X-Merchant-Id*string

Merchant 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.

Match^mrc_[0-9a-f]{32}$
X-Correlation-Id?string

Opcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.

Match^[A-Za-z0-9._-]{1,64}$

Response Body

Página do extrato.

application/json
  1. response
data*array<>
hasMore*boolean

Há página seguinte.

nextCursor*|

Cursor opaco e assinado da página seguinte; null quando hasMore é false.

Example Request
curl -X GET 'https://api.sandbox.kodano.com.br/v1/statement' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'X-Correlation-Id: erp-7f3a-0010'
Example Response
{  "data": [    {      "id": "ste_k3v9q0d2m7x1c8b5n4r6t2y0wa",      "type": "DEBIT",      "category": "WITHDRAWAL",      "amount": 150150,      "currency": "BRL",      "balanceAfter": 1523490,      "referenceId": "wdr_0192f3b0c4d17e8a9b2f5c6d7e8f9a0b",      "occurredAt": "2026-10-16T13:58:02Z"    },    {      "id": "ste_p8n2w5c1x9v4b7m3k6q0r2t5ya",      "type": "CREDIT",      "category": "PAYMENT",      "amount": 48250,      "currency": "BRL",      "balanceAfter": 1673640,      "referenceId": "pay_8f2c1e9a",      "occurredAt": "2026-10-16T12:40:11Z"    }  ],  "hasMore": true,  "nextCursor": "eyJ2IjoxLCJ0YyI6IiIsIm8iOjIsInJiIjoxNjczNjQwfQ.Xq3vM8pL2nR7"}