Deposits and withdrawals are two independent lifecycles, and both report progress in a field called status. This page lists every value each one can take.
Three values exist on both sides and do not mean the same thing
error, canceled and refunded appear in both lists. refunded is the one that costs money if you read it from the wrong list: on a deposit it means the money went back to the payer, usually through MED; on a withdrawal it means the payout failed and the reserved funds were returned. Same word, opposite events.Always interpret a status against the operation that produced it β the endpoint you called, or the webhookType on the callback β never by the value alone.
The deposit status string gives information about a deposit's current state. These are the statuses that exist today:
canceled - If the payment was canceled by the end user, by our partner or by us. Please contact our team for more details about what happened.
under_review - The payment was received from the end user but is under review by us. If this status takes too long, please let us know.
will_refund- The payment will be refunded to the payer. This occurs when the transaction cannot be completed due to risk management or compliance violations.
approved - It means we received the end userβs PIX payment, approved it, it has already been cleared by compliance and anti-fraud, and the DePix will be sent soon. This is probably the status that interests you the most and that you should monitor.
depix_sent - It means the DePix was sent to the partner or specified address.
error - If any error occurred during the process, please contact us to find out if the error is reversible or not.
refunded - It means the amount was refunded to the user who initially made the deposit, probably through a special refund mechanism (MED).
expired - It means the QR Code expired before the end user could make the payment.
pending - It means the QR Code has been generated and is awaiting payment.
delayed - It means the payment is delayed until the date and time indicated by the delayUntil field of this response.
We recommend using approved instead of depix_sent for confirming payments because it provides a faster experience for the end user. depix_sent may take up to a few minutes, while approved should only take a few seconds.
The status string indicates the current lifecycle state of a withdrawal. The following statuses are currently supported:
unsent β The withdrawal has been created but has not yet been submitted for processing.
sending β The withdrawal is currently being processed and submitted to the banking partner.
sent β The withdrawal has been successfully submitted.
error β An error occurred during processing. The withdrawal was not successfully completed and may require retry or manual intervention.
canceled β The withdrawal was intentionally cancelled before being successfully sent.
replaced β The withdrawal was superseded by a new one, created by our team to re-issue the same payout under a new withdrawal ID.
refunded β The withdrawal could not be completed, so the DePix was returned on the Liquid Network β to the refundAddress declared on the request, or to an address arranged with our team when none was declared. It is a return of DePix, not a Pix transfer: nothing reaches the beneficiary's Pix key, and the Liquid transaction id is not returned by this endpoint today.
replaced is not a failure. It means the payout was re-issued, not aborted, and it may still be completed under the new withdrawal ID. Do not refund your end user and do not create a replacement withdrawal on your side when you see it β that would pay twice. The new withdrawal ID is not returned by this endpoint today, so contact our team to have it linked.
Treat both lists as open-ended. New statuses may be added as the product evolves, so send any value your integration does not recognize to manual review instead of treating it as a failure.