post
https://api-sandbox.asaas.com/v3/payments//undoReceivedInCash
Endpoint responsible for undoing a manual confirmation of cash receipt performed previously.
Use this endpoint only when a charge was marked as received in cash by mistake and this confirmation needs to be reverted.
When to use this endpoint
Use this endpoint for operational corrections, such as:
- charge marked as received in cash by mistake;
- manual confirmation made for the incorrect customer or amount;
- need to correct the integration’s financial reconciliation;
- reversal of a manual settlement before redoing the process correctly.
This endpoint should not be used to refund payments received by Pix, bank slip, card, or TED. It only undoes the manual confirmation of cash receipt.
Preconditions
To undo the confirmation, the charge must:
- exist in the account authenticated by the API;
- have been manually confirmed as received in cash;
- be in a situation that allows this confirmation to be reverted.
The call must be made using the API key of the account responsible for the charge.
Request parameter
id— Unique charge identifier in Asaas, sent in the request path.
Example:
/v3/payments/pay_123456789/undoReceivedInCashExpected behavior
When undoing the confirmation:
- the charge is no longer listed as received in cash;
- the manual settlement is reverted;
- the charge goes back to representing an open or unconfirmed amount, according to the applicable state;
- the integration’s financial reconciliation must be updated.
This operation does not move money and does not perform a refund. It only corrects the manual record made previously.
Request example
curl --request POST \
--url https://api-sandbox.asaas.com/v3/payments/pay_123456789/undoReceivedInCash \
--header 'access_token: $ASAAS_API_KEY'Common errors
| Code | When it may occur |
|---|---|
| 400 | The charge does not allow undoing the manual confirmation or was not received in cash |
| 401 | The API key is missing, invalid, or does not have permission for the account |
| 404 | The charge was not found for the authenticated account |
Best practices
- Consult the charge before executing the reversal.
- Internally validate whether the manual settlement was made by mistake.
- Record the reason for the reversal in the source system.
- Update the reconciliation after the call.
- Avoid executing the operation automatically without operational validation.
Related content
- Confirm cash receipt
- Consult charge
- List charges
- Webhooks
404Not found
