Listar pagamentos
/v1/paymentsLista os pagamentos do merchant (inclusive os criados pelo portal e por link), recortados pelos métodos com read concedido. Ordem createdAt desc, desempate por id; sem totalCount. ?status aplica exatamente o mapeamento de status públicos.
X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).
AuthorizationBearer <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: payments:pix:read
status?stringUm dos nove status públicos.
"PENDING""AUTHORIZED""CAPTURED""SUCCEEDED""FAILED""CANCELED""REFUNDED""PARTIALLY_REFUNDED""CHARGEBACK"method?stringFora dos métodos concedidos → 403.
"PIX""BOLETO""CARD"createdFrom?stringInício inclusivo [from, to).
date-timecreatedTo?stringFim exclusivo; from > to → VALIDATION.RANGE.
date-timecustomerId?stringMalformado ou de outro merchant → lista vazia.
^cus_paymentLinkId?stringPagamentos de um link.
^ord_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 pagamentos.
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/payments' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "pay_OhbVrpoiVgRV5IfLBcbfnoGMbJmT", "status": "SUCCEEDED", "statusReason": null, "method": "PIX", "amount": 15990, "currency": "BRL", "description": "Pedido 123", "customer": { "id": "cus_iGFfWd3hjOkYRBMe", "name": "Ana Souza", "document": "123******09" }, "pix": { "qrCode": "00020101021226870014br.gov.bcb.pix2565pix.exemplo.com.br/qr/v3/at/3f1c9e2a-8b7d-4e51-9a0c-6d2f1e7b4c93520400005303986540515990.005802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304B14A", "copyPaste": "00020101021226870014br.gov.bcb.pix2565pix.exemplo.com.br/qr/v3/at/3f1c9e2a-8b7d-4e51-9a0c-6d2f1e7b4c93520400005303986540515990.005802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304B14A", "expiresAt": "2026-10-16T14:00:00Z", "endToEndId": "E13935893202610161302a1B2c3D4e5F" }, "boleto": null, "card": null, "nextAction": null, "failure": null, "refundedAmount": 0, "refundedAt": null, "paymentLinkId": null, "metadata": { "orderRef": "123" }, "createdAt": "2026-10-16T13:00:00Z", "updatedAt": "2026-10-16T13:02:11Z" } ], "hasMore": true, "nextCursor": "eyJjIjoiMjAyNi0xMC0xNlQxMzowMDowMFoiLCJpIjo5ODIxLCJkIjoiZGVzYyIsImYiOiI0YzFhOWUwMiJ9.k3JxQ0"}