Listar estornos do pagamento
/v1/payments/{id}/refundsEstornos do pagamento, inclusive os feitos pelo portal ou pela caução (reason: null, metadata: {}). Ajustes de captura parcial não aparecem.
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
id*stringId do pagamento (pay_…). Malformado → 404.
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}$Estornos.
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/string/refunds' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "data": [ { "id": "ref_Xsf2o3gyrDO1xkxwnQrS7RPeMOkI", "paymentId": "pay_2wMqZcUDIh7yfJs1ON43xKmTecQo", "amount": 5000, "currency": "BRL", "status": "SUCCEEDED", "reason": "REQUESTED_BY_CUSTOMER", "metadata": { "ticket": "SUP-123" }, "failure": null, "createdAt": "2026-10-16T16:20:00Z", "updatedAt": "2026-10-17T09:10:00Z" } ], "hasMore": false, "nextCursor": null}