Estornos

Quando uma cobrança possui um ou mais estornos, a API retorna o array refunds.

Cada item representa um estorno vinculado à cobrança e informa seu valor, status e comprovante, quando disponível.

Quando utilizar

Consulte o array refunds para:

• identificar estornos totais ou parciais;
• acompanhar a conclusão da devolução;
• atualizar o status financeiro do pedido;
• conciliar os valores estornados;
• disponibilizar o comprovante ao cliente;
• acompanhar a devolução de valores com split.

Exemplo de retorno

{
  "refunds": [
    {
      "dateCreated": "2022-02-21 10:28:40",
      "status": "DONE",
      "value": 2.00,
      "description": "Pagamento a mais",
      "endToEndIdentifier": null,
      "transactionReceiptUrl": "https://www.asaas.com/comprovantes/6677732109104548",
      "refundedSplits": [
        {
          "id": "cff860dd-148e-48ca-ac8e-849684175158",
          "value": 2.00,
          "done": true
        }
      ]
    }
  ]
}

Campos do estorno

Status do estorno

Trate o estorno na integração

Ao consultar uma cobrança:

1. verifique se o array refunds foi retornado;
2. percorra todos os itens do array;
3. armazene o valor e o status de cada estorno;
4. considere como devolvidos somente os itens com status DONE;
5. atualize o pedido e a conciliação financeira;
6. disponibilize o comprovante quando transactionReceiptUrl estiver preenchido.

Uma cobrança pode possuir mais de um estorno. Por isso, não utilize somente o primeiro item do array.

Estornos com split

Quando a cobrança possuir divisão de valores, o campo refundedSplits informa como o estorno afetou cada split.

Para cada item, utilize:

Cuidados na conciliação

• Some apenas os estornos com status DONE.
• Não inclua itens CANCELLED no total devolvido.
• Trate endToEndIdentifier e transactionReceiptUrl como opcionais.
• Preserve o histórico quando houver mais de um estorno.
• Não substitua o valor original da cobrança pelo valor estornado.
• Considere a possibilidade de estornos parciais.

Próximos passos

• Configure Webhooks
• Consulte os eventos de cobranças
• Entenda o fluxo de chargeback