Intenções de pagamento
Cancelar intenção não confirmada
Só enquanto REQUIRES_TOKEN ou REQUIRES_CONFIRMATION. Intenção confirmada virou transação; cancelar transação é outra rota, ainda não disponível.
AuthorizationBearer <token>
Chave de API da sua empresa. Por enquanto a SwitchPay gera a chave e entrega à sua empresa; em breve será possível criar pelo painel.
In: header
Path Parameters
idstring
Id com prefixo, exatamente como a API devolveu.
Length
length <= 64Header Parameters
Idempotency-Key?string
Chave de idempotência. Opcional nesta rota.
Length
length <= 255Response Body
curl -X POST "https://api.sandbox.switchpay.app.br/v2/payment-intents/string/cancel" \ -H "Idempotency-Key: string"{
"id": "pi_7b2f9c1e-4d3a-4c6b-9e1f-2a3b4c5d6e7f",
"status": "CANCELED",
"amountCents": 15000,
"paymentMethod": "PIX",
"installments": 1,
"sellerId": "cmp_8f2a1c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"referenceId": "pedido-8842",
"buyer": {
"name": "Maria Souza",
"document": "12345678909",
"email": "maria@exemplo.com",
"phone": {
"country": "55",
"area": "11",
"number": "987654321"
}
},
"expiresAt": "2026-10-06T14:05:00.000Z",
"createdAt": "2026-10-06T14:00:00.000Z",
"updatedAt": "2026-10-06T14:02:00.000Z"
}{
"code": "UNAUTHORIZED",
"message": "Chave de API ausente, inválida ou de outro ambiente."
}{
"code": "FORBIDDEN",
"message": "Sua chave não tem permissão para esta operação."
}{
"code": "NOT_FOUND",
"message": "Recurso não encontrado."
}{
"code": "INTENT_ALREADY_PROCESSED",
"message": "Esta intenção já foi confirmada, cancelada ou expirou."
}{
"code": "RATE_LIMITED",
"message": "Limite de chamadas atingido. Aguarde e tente de novo."
}{
"code": "SERVICE_UNAVAILABLE",
"message": "Serviço de autorização indisponível. Tente novamente em instantes."
}