🧵 Deposit Status Strings

The deposit status string provides real-time information about the current state of a transaction. Below are the statuses used in the FlamPix Gateway API and their respective meanings.

Status Definitions

`awaiting_payment`

The PIX QR Code has been successfully generated and is currently awaiting payment from the end user. This is the initial state of every deposit.

`processing`

The PIX payment was received by our system. The transaction is now in one of the following stages:

Conversion: Being automatically converted from BRL to DePix.

Risk Hold: Held for a security period (Anti-Fraud) as defined by the account's risk settings.

Verification: Under manual or automated review by our compliance team.

`paid`

The "happy path" conclusion. It means we received the PIX payment, converted it, and successfully sent the DePix to the partner's wallet or the specified destination address on the Liquid Network.

`expired`

The PIX QR Code expired before the end user could make the payment. Once a deposit is expired, it can no longer be paid.

`cancelled`

The transaction was cancelled. This can happen due to:

Manual Cancellation: Requested by the partner or the FlamPix team.

Refund: The amount was sent back to the original payer (e.g., via MED - Special Refund Mechanism).

System Rule: Rejection due to compliance or internal security policies.

`error`

A technical error occurred during the process (e.g., blockchain communication failure or provider timeout). In most cases, our team is automatically notified to resolve the issue manually.

Status Mapping Summary

If you are integrating with our system, these are the transitions you should expect:

Status	Type	Webhook Event
`awaiting_payment`	Initial	`deposit_created`
`processing`	Intermediate	`payment_received`
`paid`	Final (Success)	`completed`
`expired`	Final (Failure)	`payment_expired`
`cancelled`	Final (Failure)	`payment_cancelled`
`error`	Final (Failure)	`payment_cancelled`

🛡️ Note on Risk Management (Anti-Fraud)

If a deposit is flagged by our Anti-Golpe (Anti-Fraud) system, it may stay in the processing status for a few hours (as configured in your gateway settings) even after the PIX is paid. Once the hold period ends, it will automatically transition to paid.

Status Definitions#

awaiting_payment#

processing#

paid#

expired#

cancelled#

error#

Status Mapping Summary#

🛡️ Note on Risk Management (Anti-Fraud)#