Request Cancellation

API data

API Gateway
This API is used for payment gateway operations:

• Production: https://api.sopague.com.br/gateway
• Sandbox: https://api-hmg.sopague.com.br/gateway
• Architecture: Representational State Transfer (REST)

Create a cancellation request

Used to create a new transaction cancellation request for past dates and other capture types (POS, TEF, WEB, etc.). The endpoint validates whether the transaction exists and whether there is no prior cancellation request for it.

POST /v1/refund/request

Data dictionary - Request body

FIELD	DESCRIPTION	TYPE	SIZE	NOTES
Nsu	Operation identification number	string	100	Required
AuthorizationCode	Operation authorization code	string	30	Required
Amount	Total transaction amount	decimal	10,4	Required
OperationDate	Operation date	date	-	Format: YYYY-MM-DD. Required
Description	Reason for the cancellation request	string	100	Required

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

or

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

🔴 400 - Request already exists

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

Data dictionary - Response

FIELD	DESCRIPTION	TYPE	NOTES
id	Unique identifier of the cancellation request	guid	-
status	Request status	string	PENDENTE
message	Confirmation message	string	-
dataCriacao	Request creation date and time	datetime	-