Como efetuar estornos pela API?

Nesse artigo você irá aprender:

1. Como realizar um reembolso por api.
2. Qual gatilho receber para ser notificado que ocorreu um reembolso no painel da iugu.

Para mais informações sobre reembolso (estorno), indicamos que leia os artigos abaixo para seguir adiante neste artigo:

• Como efetuo estornos?
• Como emitir um comprovante de estorno?
• É possível realizar um estorno parcial?

 

1. Reembolso por API:

Caso de uso: Um cliente entrou em contato informando que gostaria de realizar o estorno de uma cobrança, pois não gostou do produto ou serviço contratado.

Modelo de diagrama de sequência:

 

Para realizar o reembolso é necessário realizar um POST na api Reembolsar faturas, passando na url da request, o id da fatura que deseja estornar, ou seja, devolver o valor ao cliente que fez a compra.

Modelo de request:

Modelo de response:

 

Caso exista a necessidade de realizar um reembolso parcial da fatura, basta inserir no corpo da request a propriedade partial_value_refund_cents.

Ela deve ser informada em centavos e no formato int32.

Por exemplo, para estornar apenas R$10,00 de uma fatura de R$ 80,00, é necessário realizar a seguinte request:

 

2. Gatilho de reembolso de uma fatura:

Caso de uso: Um cliente entrou em contato informando que deseja realizar o estorno de uma fatura, porém, por uma estratégia definida pela empresa, para que o processo possa ocorrer, o cliente precisa conversar com um atendente que terá acesso ao painel da iugu para realizar o estorno. Mas além do estorno estar visível pelo painel da iugu, é necessário que essa atualização de estorno também seja replicada para o site, atualizando o pedido desse cliente para o status de "estornado".

 

Modelo de diagrama de sequência:

 

Após ser realizado o estorno dentro do painel da iugu, será enviado o gatilho invoice.refunded, onde será apresentado o id da fatura que foi estornada.

Se a sua empresa trabalha com estorno parcial, para saber o valor estornado é necessário realizar um GET na api Consultar Faturas passando seu na url da request.

Modelo de request:

 

 

Para saber mais informações e também para assistir ao vídeo com todos os passo a passo que produzimos sobre o conteúdo, assista ao vídeo a seguir: