Solicitar Cancelamento

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)

Criar solicitação de cancelamento

Utilizada para criar uma nova solicitação de cancelamento de transação para datas retroativas e outros tipos de captura (POS, TEF, WEB e etc). O endpoint valida se a transação existe e se não há solicitação prévia de cancelamento para ela.

POST /v1/refund/request

Dicionário de dados - Request Body

CAMPO	DESCRIÇÃO	TIPO	TAMANHO	OBSERVAÇÃO
Nsu	Número de identificação da operação	string	100	Obrigatório
AuthorizationCode	Código de autorização da operação	string	30	Obrigatório
Amount	Valor total da transação	decimal	10,4	Obrigatório
OperationDate	Data da operação	date	-	Formato: YYYY-MM-DD. Obrigatório
Description	Motivo da solicitação de cancelamento	string	100	Obrigatório

🟢 201 - Created

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDENTE",
  "message": "Solicitação de cancelamento criada com sucesso",
  "dataCriacao": "2024-11-12T10:30:00"
}

🔴 400 - Bad Request

{
  "error": "Transação não encontrada com os dados informados"
}

ou

{
  "error": "Já existe uma solicitação de cancelamento com status 'PENDENTE' para esta transação"
}

🔴 400 - Solicitação já existente

{
  "error": "Já existe uma solicitação de cancelamento para esta transação"
}

Dicionário de dados - Response

CAMPO	DESCRIÇÃO	TIPO	OBSERVAÇÃO
id	Identificador único do pedido de cancelamento	guid	-
status	Status do pedido	string	PENDENTE
message	Mensagem de confirmação	string	-
dataCriacao	Data e hora da criação do pedido	datetime	-