Pular para o conteúdo principal

Cancelar um Pagamento

PUT 
/v2/payments/:uid/cancel

Processamento Assíncrono: Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento. O cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.

Eventos de Webhook​

Quando a requisição é realizada, um evento payment.{type}.cancel.requested é disparado (onde {type} pode ser pix, bank_billet, etc). O nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira. Somente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados. Neste momento o evento payment.{type}.cancel.confirmed é disparado.

⚠️ Atenção ao status Cancelado: O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.

Request​

Responses​

Pagamento cancelado sem interação com provedor