Solicitar Cancelamento

POST/v1/refund/request

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

Dicionário de dados - Body

Exemplo de requisição

{
  "Nsu": "123456789",
  "AuthorizationCode": "ABC123",
  "Amount": 150.50,
  "OperationDate": "2024-11-12",
  "Description": "Solicitação do cliente"
}

Retorno (200)

Exemplo de resposta

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

Dicionário de dados

Todo token tem prazo de validade. Renove antes da expiração.

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": "Transação não encontrada com os dados informados"
}

Exemplo documentado

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

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": "Nsu",
    "description": "TrNSU é obrigatório"
  },
  {
    "tag": "AuthorizationCode",
    "description": "CodAuth é obrigatório"
  },
  {
    "tag": "Amount",
    "description": "Valor deve ser maior que zero"
  },
  {
    "tag": "OperationDate",
    "description": "Data da operação é obrigatória"
  },
  {
    "tag": "Description",
    "description": "Motivo é 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.