Estornar pagamento
/v1/payments/{id}/refundsEstorna, total ou parcialmente, um pagamento PIX ou cartão. Parciais sequenciais somam no máximo o valor estornável (PIX: pago; cartão: capturado). O 201 sai PENDING (PIX até o webhook do provedor; cartão até o próximo relatório de liquidação) ou SUCCEEDED; o desfecho chega por payment.refunded ou GET /v1/payments/{id}/refunds. A borda aceita qualquer payments:{pix,boleto,cards}:write; o serviço exige o write do método do pagamento. Sandbox (simulador): ≤ 300000 → SUCCEEDED; 300001–400000 → 422 REFUND.PROVIDER_REJECTED; 400001–600000 → PENDING sem desfecho; acima → SUCCEEDED.
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:write
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}$Idempotency-Key*stringUUID, retido por 24 h a partir da primeira chamada. Escopo: (tenant, merchant, rota-template, chave). Mesma chave e mesmo corpo → resposta original (2xx ou 4xx) com X-Idempotent-Replay: true; corpo ou path concreto diferente → 409 IDEMPOTENCY.CONFLICT; em execução ou desfecho desconhecido → 409 IDEMPOTENCY.IN_PROGRESS com resourceId e Retry-After: 2. Ausente ou não-UUID → 422 IDEMPOTENCY.KEY_REQUIRED.
uuidX-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}$application/json- body
amount?integerOmitido = availableRefundAmount.
1 <= valuereason?string"REQUESTED_BY_CUSTOMER""DUPLICATE""FRAUDULENT""OTHER"metadata?Até 20 chaves ^[A-Za-z0-9_.-]{1,40}$, valores string ≤ 500; devolvido tal qual.
properties <= 20Estorno criado (ou replay). Location: /v1/payments/{id}/refunds.
application/json- response
id*string^ref_paymentId?string^pay_amount*integercurrency*"BRL"Único valor na v1.
"BRL"status*string"PENDING""SUCCEEDED""FAILED"reason*|null em estorno do portal ou da caução.
"REQUESTED_BY_CUSTOMER""DUPLICATE""FRAUDULENT""OTHER"nullmetadata?Até 20 chaves ^[A-Za-z0-9_.-]{1,40}$, valores string ≤ 500; devolvido tal qual.
properties <= 20failure*|nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/payments/string/refunds' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'Idempotency-Key: 4b2e8c1a-9d7f-4e3b-a6c5-0f1e2d3c4b5a' \ -H 'X-Correlation-Id: erp-7f3a-0010' \ -H 'Content-Type: application/json' \ -d '{ "amount": 5000, "reason": "REQUESTED_BY_CUSTOMER", "metadata": { "ticket": "SUP-123" }}'{ "id": "ref_Xsf2o3gyrDO1xkxwnQrS7RPeMOkI", "paymentId": "pay_2wMqZcUDIh7yfJs1ON43xKmTecQo", "amount": 5000, "currency": "BRL", "status": "PENDING", "reason": "REQUESTED_BY_CUSTOMER", "metadata": { "ticket": "SUP-123" }, "failure": null, "createdAt": "2026-10-16T16:20:00Z", "updatedAt": "2026-10-16T16:20:01Z"}