Cancelar pré-autorização

Cancela uma cobrança `RequiresCapture` e libera o valor reservado no cartão do comprador. Nada é cobrado. `200` confirma o cancelamento (`status: "Canceled"`) e o webhook `payment_intent.canceled` é enviado. Depois da captura não há cancelamento: use o estorno.

POST

/api/v1/paymentintents/{id}/cancel

Cancela uma cobrança RequiresCapture e libera o valor reservado no cartão do comprador. Nada é cobrado. 200 confirma o cancelamento (status: "Canceled") e o webhook payment_intent.canceled é enviado. Depois da captura não há cancelamento: use o estorno.

Autenticação

ApiKey

headerAuthorization<token>

A chave de API crua, sem prefixo: kpa_test_sk_… no sandbox e kpa_live_sk_… em produção. Use apenas no servidor.

Parâmetros de rota

id*string

Formatouuid

Cabeçalhos

Corpo da requisição

application/json

body

cancellationReason?string

Sempre em minúsculas. expired é só da Accelerazione, quando o prazo da reserva vence.

Padrão"requested_by_customer"

Valores aceitos"requested_by_customer""duplicate""fraudulent""abandoned"

Corpo da resposta

Cancelamento confirmado; o valor foi liberado.

application/json

response

id?string

Formatouuid

object?string

amount?integer

currency?string

status?PaymentIntentStatus

Valores aceitos"Created""Processing""RequiresAction""RequiresCapture""Succeeded""Failed""Canceled""Refund""ChargedBack"

statusDetail?|

Lista aberta, ex. PENDING_CHALLENGE, AUTHENTICATION_FAILED.

merchantId?string

captureMethod?string

Como a cobrança é capturada. Automatic em toda cobrança sem pré-autorização.

Valores aceitos"Automatic""Manual"

amountCapturable?integer

Centavos que ainda podem ser capturados. Maior que 0 só em RequiresCapture.

amountCaptured?integer

Centavos capturados. Numa cobrança Automatic paga, é o valor total.

amountReleased?integer

Centavos liberados de volta ao limite do comprador (cancelamento, expiração ou sobra da captura).

authorizedAt?|

Formatodate-time

captureBefore?|

Prazo da reserva. Depois dele a autorização é liberada sozinha e a cobrança vira Canceled com cancellationReason expired.

Formatodate-time

capturedAt?|

Formatodate-time

canceledAt?|

Formatodate-time

cancellationReason?|

Valores aceitos"requested_by_customer""duplicate""fraudulent""abandoned""expired"null

lastCaptureError?|

Última falha de captura ou cancelamento. Com code capture_ambiguous ou void_ambiguous, o resultado ainda está sendo confirmado: consulte a cobrança antes de repetir.

capture?|

Operação de captura ou cancelamento em curso ou concluída. null até a primeira operação.

paymentMethods?array<>

customer?

split?|null

metadata?

lastPaymentError?|null

nextAction?|null

pixPayment?|null

pagalevePayment?|null

postbackUrl?string|null

description?string|null

statementDescriptor?string|null

created?string

Formatodate-time

succeededAt?|

Formatodate-time

Exemplo de requisição

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/paymentintents/8b727267-bf39-48a4-91ea-eb0780cb48a9/cancel' \
  -H 'Content-Type: application/json' \
  -d '{
  "cancellationReason": "requested_by_customer"
}'

Exemplo de requisição

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/paymentintents/8b727267-bf39-48a4-91ea-eb0780cb48a9/cancel' \  -H 'Content-Type: application/json' \  -d '{  "cancellationReason": "requested_by_customer"}'

Exemplo de respostaEsquema

{
  "id": "3b8f6c2a-91d4-4e7b-a0c5-6d2e8f1a4b97",
  "object": "payment_intent",
  "amount": 10990,
  "currency": "BRL",
  "status": "Canceled",
  "captureMethod": "Manual",
  "amountCapturable": 0,
  "amountCaptured": 0,
  "amountReleased": 10990,
  "authorizedAt": "2026-11-04T18:00:00Z",
  "captureBefore": "2026-11-11T18:00:00Z",
  "capturedAt": null,
  "canceledAt": "2026-11-05T09:10:00Z",
  "cancellationReason": "requested_by_customer",
  "lastCaptureError": null,
  "capture": null,
  "paymentMethods": [
    {
      "type": "CreditCard",
      "amount": 10990,
      "currency": "BRL",
      "status": "Voided",
      "amountCapturable": 0,
      "amountCaptured": 0,
      "card": {
        "maskedNumber": "**** **** **** 4444",
        "expMonth": 12,
        "expYear": 2030,
        "holderName": "MARIA SOUZA",
        "brand": "MASTERCARD",
        "lastFourDigits": "4444",
        "bin": "555555",
        "threeDs": null
      },
      "pix": null
    }
  ],
  "lastPaymentError": null,
  "nextAction": null,
  "metadata": {
    "orderId": "pedido-1001"
  },
  "created": "2026-11-04T18:00:00Z"
}

{  "id": "3b8f6c2a-91d4-4e7b-a0c5-6d2e8f1a4b97",  "object": "payment_intent",  "amount": 10990,  "currency": "BRL",  "status": "Canceled",  "captureMethod": "Manual",  "amountCapturable": 0,  "amountCaptured": 0,  "amountReleased": 10990,  "authorizedAt": "2026-11-04T18:00:00Z",  "captureBefore": "2026-11-11T18:00:00Z",  "capturedAt": null,  "canceledAt": "2026-11-05T09:10:00Z",  "cancellationReason": "requested_by_customer",  "lastCaptureError": null,  "capture": null,  "paymentMethods": [    {      "type": "CreditCard",      "amount": 10990,      "currency": "BRL",      "status": "Voided",      "amountCapturable": 0,      "amountCaptured": 0,      "card": {        "maskedNumber": "**** **** **** 4444",        "expMonth": 12,        "expYear": 2030,        "holderName": "MARIA SOUZA",        "brand": "MASTERCARD",        "lastFourDigits": "4444",        "bin": "555555",        "threeDs": null      },      "pix": null    }  ],  "lastPaymentError": null,  "nextAction": null,  "metadata": {    "orderId": "pedido-1001"  },  "created": "2026-11-04T18:00:00Z"}

Cancelar pré-autorização

AutenticaçãoCopiar link da seção

Parâmetros de rotaCopiar link da seção

CabeçalhosCopiar link da seção

Corpo da requisiçãoCopiar link da seção

Corpo da respostaCopiar link da seção

Autenticação

Parâmetros de rota

Cabeçalhos

Corpo da requisição

Corpo da resposta