Pagamentos Deletar pagamento

Deletar um pagamento

Endpoint para deletar em definitivo uma cobrança com um identificador de transação.

Removendo o pagamento!

Para deletar um pagamento um DELETE para a rota /v2/payments/{ID}. Em resposta, você receberá o objeto com as informações do pagamento solicitado.

AÇÃO IRREVERSÍVEL

Ao deletar o pagamento não será possível recuperar os dados do mesmo, certifique que seu cliente desistiu da compra antes de solicitar a remoção do pagamento!

DELETE /v2/payments/:id

Requer autorização para o escopo: payments.write

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRQYXltZW50SUQ9ICd7SUR9JzsKJGhlYWRlcnMgPSBhcnJheSgKCSdBdXRob3JpemF0aW9uOiBCZWFyZXIgJy4kQWNjZXNzVG9rZW4sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJywKKTsKJGNoID0gY3VybF9pbml0KCk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9VUkwsICd7QVBJX1VSTH0vdjIvcGF5bWVudHMvJy4kUGF5bWVudElEKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0hUVFBIRUFERVIsICRoZWFkZXJzKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1JFVFVSTlRSQU5TRkVSLCBUUlVFKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0NVU1RPTVJFUVVFU1QgLCAnREVMRVRFJyk7CmN1cmxfc2V0b3B0KCRjaCwgQ1VSTE9QVF9TU0xfVkVSSUZZUEVFUiwgRkFMU0UpOwokcmVzcG9uc2UgPSBjdXJsX2V4ZWMoJGNoKTsJCmN1cmxfY2xvc2UoJGNoKTsKCmVjaG8gJHJlc3BvbnNlOwo/Pg==

Respostas possíveis

200 404 403

/* Esse exemplo de resposta de sucesso! */
{
  "access": "granted",
  "payments": {
    "id": "TRR-00000000000000000000",
    "deleted": true
  }
}

/* Esse exemplo de resposta ocorre quando o aplictivo não tem permissão no escopo para usar esse endpoint */
{
  "access": "not-found",
  "giftcards": {
    "error": "Payment ID não encontrado",
    "error_code": 93,
    "error_status": 404
  }
}

/* Esse exemplo de resposta ocorre quando o aplictivo não tem permissão no escopo para usar esse endpoint */
{
  "access": "unauthorized",
  "giftcards": {
    "error": "App sem permissão para usar este endpoint",
    "error_code": 90,
    "error_status": 403
  }
}

A tabela abaixo descreve os atributos presentes no JSON retornado.

access

Retorna granted informado sobre o sucesso da solicitação.

payments Sem resultados retorna um objeto vazio.

id ID do pagamento atual. string
deleted Resultado da requisição. boleano

Última atualização em 26 de dez. de 2024