SopagueDocs
v3

Cancelar Pedido de Estorno

POST/v1/refund/cancel

Utilizada para cancelar um pedido de cancelamento que está com status PENDENTE. Após o cancelamento, o pedido não será mais processado.

Dicionário de dados - Request Body

Exemplo de requisição
{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Exemplo de resposta
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "CANCELADO",
  "message": "Status alterado para CANCELADO com sucesso",
  "lastModifiedOn": "2024-11-12T14:30:00"
}

Dicionário de dados - Response

Regras de Cancelamento

  • Apenas pedidos com status PENDENTE podem ser cancelados
  • Após cancelado, o pedido não pode ser revertido

Fluxo de Status

O pedido de cancelamento pode ter os seguintes status:

StatusDescrição
PENDENTEAguardando processamento
CANCELADOCancelado pelo usuário (via esta API)
APROVADOProcessado e aprovado pela equipe
REJEITADOProcessado e rejeitado pela equipe

Esta API só pode alterar pedidos de PENDENTE para CANCELADO.