Guia de Estornos

Confira o guia de estornos para mais informações.

Este endpoint permite realizar o estorno de uma cobrança retornando uma resposta resumida da operação.

Além do estorno da cobrança principal, também é possível definir como o valor deverá ser distribuído entre a cobrança e os participantes do Split de Pagamentos por meio do campo splitRefunds.

Quando utilizar este endpoint

Utilize este endpoint quando sua integração precisar:

• realizar um estorno total da cobrança;
• realizar um estorno parcial;
• controlar quanto do estorno deverá ser aplicado aos participantes do Split de Pagamentos;
• integrar fluxos de marketplaces ou plataformas que utilizam divisão automática de recebimentos.

Como o valor do estorno é calculado

O comportamento do estorno depende dos campos enviados na requisição.

Parâmetros que merecem atenção

Embora todos os parâmetros estejam documentados na referência técnica abaixo, alguns possuem impacto direto no comportamento da operação:

• value: define o valor total que será estornado.
• splitRefunds: permite distribuir parte do estorno entre os participantes do Split de Pagamentos.
• description: permite registrar o motivo do estorno para auditoria e rastreabilidade.

Exemplos de utilização

Estorno integral

Não informar value nem splitRefunds.

Resultado:

• toda a cobrança será estornada.

Estorno parcial

Informar apenas value.

Resultado:

• será estornado somente o valor informado.

Estorno utilizando Split de Pagamentos

Informar value juntamente com splitRefunds.

Resultado:

• parte do estorno será realizada sobre os participantes do split;
• caso exista diferença entre o valor total do estorno e os valores distribuídos nos splits, o saldo remanescente será deduzido da cobrança principal.

Boas práticas

Antes de solicitar um estorno, recomenda-se:

• validar se a cobrança está apta para estorno;
• conferir os valores enviados em value e splitRefunds;
• manter um identificador interno da operação para facilitar auditorias e conciliações;
• registrar o motivo do estorno utilizando o campo description, quando aplicável.

Impacto operacional

Quando a cobrança utiliza Split de Pagamentos, a distribuição dos valores informados em splitRefunds impacta diretamente a forma como o estorno será realizado entre a cobrança principal e seus respectivos participantes.

Por esse motivo, recomenda-se validar previamente os valores enviados para manter a consistência da conciliação financeira entre o Asaas e o sistema de origem.

Conteúdos relacionados

Este endpoint normalmente faz parte do seguinte fluxo:

Criar cobrança
        ↓
Receber pagamento
        ↓
Solicitar estorno
        ↓
Atualizar conciliação financeira

Consulte também

• Guia de Estornos;
• Split de Pagamentos;
• Consultar cobrança.