Cancelar Pedido
Dados da API
API Gateway
Esta API é utilizada para operações do gateway de pagamento:
- Produção: https://api.sopague.com.br/gateway
- Homologação: https://api-hmg.sopague.com.br/gateway
- Arquitetura: Representational State Transfer (REST)
Cancelar pedido de cancelamento
Utilizada para cancelar um pedido de cancelamento que está com status PENDENTE. Após o cancelamento, o pedido não será mais processado.
POST /v1/refund/cancel
Dicionário de dados - Request Body
| CAMPO | DESCRIÇÃO | TIPO | TAMANHO | OBSERVAÇÃO |
|---|---|---|---|---|
| Id | Identificador único do pedido de cancelamento | guid | - | Obrigatório. |
- 🟢 200 - OK
- 🔴 400 - Não Encontrado
- 🔴 400 - Status Inválido
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "CANCELADO",
"message": "Status alterado para CANCELADO com sucesso",
"lastModifiedOn": "2024-11-12T14:30:00"
}
{
"error": "Pedido de cancelamento não encontrado"
}
{
"error": "Não é possível cancelar. Status atual: 'APROVADO'. Apenas pedidos com status 'PENDENTE' podem ser cancelados."
}
Dicionário de dados - Response
| CAMPO | DESCRIÇÃO | TIPO | OBSERVAÇÃO |
|---|---|---|---|
| id | Identificador único do pedido | guid | - |
| status | Novo status do pedido | string | - |
| message | Mensagem de confirmação | string | - |
| lastModifiedOn | Data e hora da última modificação | datetime | - |
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:
- 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.