Estornar parcelamento

É possível estornar um parcelamento via cartão de crédito recebido ou confirmado.

Como já ocorre no processo de estorno de uma cobrança avulsa por cartão de crédito, o saldo correspondente do parcelamento é debitado de sua conta no Asaas e a cobrança é cancelada no cartão do seu cliente. O cancelamento pode levar até 10 dias úteis para aparecer na fatura de seu cliente.

Guia de Estornos

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

Este endpoint permite estornar total ou parcialmente um parcelamento pago via cartão de crédito, desde que ele esteja confirmado ou recebido.

Ao realizar o estorno, o saldo correspondente será debitado das contas envolvidas no recebimento. O cancelamento pode levar até 10 dias úteis para aparecer na fatura do pagador, conforme o processamento da operadora do cartão.


Quando utilizar este endpoint

Utilize este endpoint para:

  • estornar total ou parcialmente um parcelamento;
  • devolver ao pagador o valor de uma compra parcelada;
  • corrigir um parcelamento criado ou pago com valor incorreto.

Para estornar uma cobrança avulsa, utilize o endpoint específico de estorno de cobrança.


Estorno integral ou parcial

  • Para estornar o valor integral do parcelamento, não informe o campo value.
  • Para estornar apenas parte do parcelamento, informe o campo value com o valor desejado.
🚧

Atenção

No estorno parcial, o valor é retirado primeiro da conta que criou a cobrança. Depois, são considerados os splits, iniciando pelo primeiro split elegível até atingir o valor informado.

Não é possível definir quanto será estornado de cada parcela ou de cada conta participante do split.

O estorno começa pelas cobranças confirmadas. Caso ainda exista valor a devolver, serão consideradas também as cobranças recebidas.

Se o campo value não for informado, será realizado o estorno integral do parcelamento.

Exemplo

Considere um parcelamento de R$ 400,00, dividido em quatro parcelas de R$ 100,00, com 50% destinado à conta que criou a cobrança e 50% destinado a outra conta por meio de split.

  • Em um estorno de R$ 400,00, os R$ 200,00 de cada conta serão estornados.
  • Em um estorno de até R$ 200,00, o valor será retirado somente da conta que criou a cobrança.
  • Em um estorno superior a R$ 200,00, primeiro serão estornados os R$ 200,00 da conta que criou a cobrança. O valor restante será retirado dos splits, começando pelas cobranças confirmadas e, depois, pelas recebidas.

Exemplos de requisição

Estornar o valor integral do parcelamento

Envie a requisição sem corpo ou com o corpo vazio.

curl --request POST \
  --url https://api-sandbox.asaas.com/v3/installments/{id}/refund \
  --header 'accept: application/json' \
  --header 'access_token: $ASAAS_API_KEY' \
  --header 'content-type: application/json' \
  --data '{}'

Estornar um valor parcial

Neste exemplo, serão estornados R$ 50,00 do parcelamento.

{
  "value": 50.00
}

Exemplo de resposta

Em caso de sucesso, serão retornados os dados atualizados do parcelamento e do estorno.

{
  "object": "installment",
  "id": "2765d086-c7c5-5cca-898a-4262d212587c",
  "value": 360.00,
  "paymentValue": 30.00,
  "installmentCount": 12,
  "billingType": "CREDIT_CARD",
  "refunds": [
    {
      "status": "DONE",
      "value": 100.00,
      "description": null,
      "refundedSplits": [
        {
          "id": "6fba235c-3726-4e32-b4e6-85f46e10cc2e",
          "value": 40.00,
          "done": true
        }
      ]
    }
  ]
}

Boas práticas de integração

Antes de solicitar o estorno, valide se o parcelamento está confirmado ou recebido e se o valor informado não ultrapassa o saldo disponível para devolução.

Em estornos parciais, registre o valor já estornado para evitar solicitações duplicadas ou superiores ao permitido.

Caso a requisição retorne erro 400, revise o valor enviado e o status do parcelamento. Para erros 401, valide a chave de API. Para erros 404, confirme o identificador do parcelamento.

Em casos de timeout ou instabilidade, consulte o parcelamento antes de realizar uma nova tentativa para verificar se o estorno já foi processado.


Impactos do estorno

Após o processamento:

  • o valor será debitado das contas envolvidas, conforme a ordem de priorização;
  • o cancelamento será solicitado à operadora do cartão;
  • o cancelamento pode levar até 10 dias úteis para aparecer na fatura do pagador;
  • o parcelamento manterá o histórico dos valores pagos e estornados.

Path Params
string
required

Identificador único do parcelamento a ser estornado.

Body Params
number

Valor total a ser estornado

Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json