Endpoint responsável por desfazer uma confirmação manual de recebimento em dinheiro realizada anteriormente.
Use este endpoint apenas quando uma cobrança foi marcada como recebida em dinheiro por engano e essa confirmação precisa ser revertida.
Quando utilizar este endpoint
Utilize este endpoint em correções operacionais, como:
- cobrança marcada como recebida em dinheiro por engano;
- confirmação manual feita no cliente ou valor incorreto;
- necessidade de corrigir a conciliação financeira da integração;
- reversão de uma baixa manual antes de refazer o processo corretamente.
Este endpoint não deve ser utilizado para estornar pagamentos recebidos por Pix, boleto, cartão ou TED. Ele desfaz somente a confirmação manual de recebimento em dinheiro.
Pré-condições
Para desfazer a confirmação, a cobrança deve:
- existir na conta autenticada pela API;
- ter sido confirmada manualmente como recebida em dinheiro;
- estar em uma situação que permita a reversão dessa confirmação.
A chamada deve ser feita usando a chave de API da conta responsável pela cobrança.
Parâmetro da requisição
id— Identificador único da cobrança no Asaas, enviado no path da requisição.
Exemplo:
/v3/payments/pay_123456789/undoReceivedInCashComportamento esperado
Ao desfazer a confirmação:
- a cobrança deixa de constar como recebida em dinheiro;
- a baixa manual é revertida;
- a cobrança volta a representar um valor em aberto ou não confirmado, conforme o estado aplicável;
- a conciliação financeira da integração deve ser atualizada.
Essa operação não movimenta dinheiro e não realiza reembolso. Ela apenas corrige o registro manual feito anteriormente.
Exemplo de requisição
curl --request POST \
--url https://api-sandbox.asaas.com/v3/payments/pay_123456789/undoReceivedInCash \
--header 'access_token: $ASAAS_API_KEY'Erros comuns
| Código | Quando pode ocorrer |
|---|---|
| 400 | A cobrança não permite desfazer a confirmação manual ou não foi recebida em dinheiro |
| 401 | A chave de API está ausente, inválida ou sem permissão para a conta |
| 404 | A cobrança não foi encontrada para a conta autenticada |
Boas práticas
- Consulte a cobrança antes de executar a reversão.
- Valide internamente se a baixa manual foi feita por engano.
- Registre o motivo da reversão no sistema de origem.
- Atualize a conciliação após a chamada.
- Evite executar a operação automaticamente sem validação operacional.
Conteúdos relacionados
- Confirmar recebimento em dinheiro
- Consultar cobrança
- Listar cobranças
- Webhooks
404Not found
