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"
}

Retorno (200)

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

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:

Status	Descrição
PENDENTE	Aguardando processamento
CANCELADO	Cancelado pelo usuário (via esta API)
APROVADO	Processado e aprovado pela equipe
REJEITADO	Processado e rejeitado pela equipe

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

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Exemplo documentado

{
  "error": "Pedido de cancelamento não encontrado"
}

Exemplo documentado

{
  "error": "Não é possível cancelar. Status atual: 'APROVADO'. Apenas pedidos com status 'PENDENTE' podem ser cancelados."
}

Observado em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

[
  {
    "tag": "Id",
    "description": "Id é obrigatório"
  }
]

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.