Cancelar Transação

Atenção

O cancelamento é irreversível. Apenas transações com status "pending" podem ser canceladas. Transações já processadas precisam ser estornadas através de outro processo.

Cancele uma transação pendente antes que ela seja processada. Este endpoint interrompe o processamento e marca a transação como cancelada definitivamente.

Endpoint

DELETE/api/v1/transactions/{id}/cancel

Condições para Cancelamento

Transações Pendentes

Podem ser canceladas a qualquer momento antes do processamento.

Transações Processadas

Não podem ser canceladas. Use o processo de estorno para transações aprovadas.

Parâmetros Opcionais

reasonstringopcional

Motivo do cancelamento para fins de auditoria (máximo 255 caracteres)

Exemplo de Requisição

cURL

curl -X DELETE "https://api.qivopay.com/v1/transactions/txn_abc123/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Cliente solicitou cancelamento"
  }'

Resposta de Sucesso

200 OK

{
  "id": "txn_abc123",
  "status": "cancelled",
  "amount": 10050,
  "currency": "BRL",
  "payment_method": "credit_card",
  "customer": {
    "id": "cust_xyz789",
    "name": "João Silva",
    "email": "joao@exemplo.com"
  },
  "cancellation": {
    "reason": "Cliente solicitou cancelamento",
    "cancelled_at": "2023-12-01T15:30:00Z",
    "cancelled_by": "api_key_xyz"
  },
  "created_at": "2023-12-01T10:30:00Z",
  "updated_at": "2023-12-01T15:30:00Z"
}

Efeitos do Cancelamento

💳 Processamento

A transação não será processada pelas operadoras de pagamento.

🔔 Webhooks

Um webhook de cancelamento será enviado para suas URLs configuradas.

📊 Relatórios

A transação aparecerá nos relatórios com status "cancelada".

Códigos de Erro

404Transação não encontrada

409Transação não pode ser cancelada (já processada)

400Transação já está cancelada

QivoPay