Utilize este método para efetuar o estorno (ou cancelamento) de uma cobrança já efetuada com sucesso. É importante observar que não é possível reverter um estorno realizado com sucesso.
Após a operação de estorno, a cobrança assumirá status=canceled. O cancelamento da fatura associda é opcional e pode ser informado através da opção cancel_bill no corpo da requisição.
Estorno total e parcial
A operação de estorno pode ser realizada na totalidade do valor original ou parcialmente, caso seja necessário. É importante observar que nem todas as adquirentes suportam a modalidade de estorno parcial.
Para efetuar o estorno total não é obrigatório informar o parâmetro amount.
Retorno síncrono e assíncrono
Caso o estorno retorne uma transação (last_transaction) contendo o atributo status=success, é possível considerar que a operação foi realizada com sucesso e o valor será creditado na fatura do cliente respeitando as regras da adquirente e do banco emissor. Chamamos esta operação de estorno síncrono.
Em alguns casos também é possível que a plataforma retorne status=waiting. Isto significa que o estorno foi recebido com sucesso, porém ainda depende de um processamento adicional na adquirente. Esta operação é chamada de estorno assíncrono. Neste caso, você poderá optar pelo recebimento do webhook "Cobrança estornada" (charge_refunded) que será enviado assim que a adquirente emitir a confirmação de estorno. O recebimento da confirmação do estorno pode demorar entre alguns minutos até alguns dias.