Cancelar autorização de cartão
/v1/payments/{id}/cancelCancela cartão AUTHORIZED (reversão, libera o limite) ou cartão PENDING que o provedor confirma não enviado à operadora (ex.: 3DS não concluído). Já CANCELED → 200 com o mesmo objeto, sem chamar o provedor. Capturado → 422 PAYMENT.NOT_CANCELABLE com reason: CAPTURED (usar estorno). Sem evento v1 de cancelamento. Corpo vazio ou {}.
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
Sem corpo ou {}; qualquer campo → 422 VALIDATION.FAILED.
properties <= 0Pagamento cancelado (ou replay).
application/json- response
Mesmo objeto no 201 dos três POST de criação, no 200 do cancel, no detalhe, em cada item da lista e em data.object dos eventos de pagamento. O bloco do método vem preenchido; os dos outros métodos vêm null.
id*stringpay_ + 28 alfanuméricos.
^pay_status*PaymentStatusNove status mutuamente exclusivos. Precedência entre os derivados de sucesso: CHARGEBACK > REFUNDED > PARTIALLY_REFUNDED > CAPTURED/SUCCEEDED > AUTHORIZED.
"PENDING""AUTHORIZED""CAPTURED""SUCCEEDED""FAILED""CANCELED""REFUNDED""PARTIALLY_REFUNDED""CHARGEBACK"statusReason*|PROVIDER_PENDING (PENDING sem instrumento após timeout do provedor), EXPIRED (CANCELED por expiração), CAPTURE_FAILED (CANCELED porque a captura imediata falhou).
"PROVIDER_PENDING""EXPIRED""CAPTURE_FAILED"nullmethod*PaymentMethod"PIX""BOLETO""CARD"amount*integerCentavos pedidos na criação.
currency*"BRL"Único valor na v1.
"BRL"description*|length <= 140customer*pix?|nullboleto?|nullcard?|nullnextAction?|nullfailure*|nullrefundedAmount*integerSoma dos estornos SUCCEEDED (o ajuste de captura parcial não conta).
refundedAt*|date-timepaymentLinkId*|ord_ quando o pagamento veio de link.
metadata*Até 20 chaves ^[A-Za-z0-9_.-]{1,40}$, valores string ≤ 500; devolvido tal qual.
properties <= 20createdAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/payments/string/cancel' \ -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 '{}'{ "id": "pay_4K8ffUF0eWIXiiQE8JkqH3MB9n7I", "status": "CANCELED", "statusReason": null, "method": "CARD", "amount": 25000, "currency": "BRL", "description": "Reserva 4480", "customer": { "id": "cus_iGFfWd3hjOkYRBMe", "name": "Ana Souza", "document": "123******09" }, "pix": null, "boleto": null, "card": { "id": "card_WrXPvhsBkDa9U4UqGWlG6g3Ot1O", "brand": "VISA", "last4": "4242", "installments": 1, "capturedAmount": null, "capturedAt": null }, "nextAction": null, "failure": null, "refundedAmount": 0, "refundedAt": null, "paymentLinkId": null, "metadata": {}, "createdAt": "2026-10-16T10:00:00Z", "updatedAt": "2026-10-16T10:05:12Z"}