Cancelar Pagamento

POST/v1/payments/{paymentId}/cancel

Cancela uma venda capturada. O cancelamento só pode ser efetuado no mesmo dia em que a transação foi realizada.

Dicionário de dados - Parâmetros

Exemplo de requisição

{
  "amount": 1035
}

Retorno (200)

Exemplo de resposta

{
  "returnCode": "0",
  "description": "Canceled",
  "paymentId": "020080286103040952150000006201850000000000",
  "authorizationCode": "143513",
  "amount": 1023,
  "releaseAt": "2019-09-24T13:43:12.1952799-03:00"
}

Dicionário de dados

Transações capturadas só podem ser canceladas no mesmo dia em que foram realizadas.

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.

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": "Amount",
    "description": "Valor para cancelamento deve ser maior que zero"
  }
]

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.