Overview
Every transfer in Qustody follows a deterministic state machine of 14 states. Understanding these states is critical for reliable integrations. Your system should handle each transition and respond to webhook events accordingly.State machine diagram
States explained
Active states
SUBMITTED
SUBMITTED
Transaction has been accepted, validated, gas estimated, and a nonce assigned. Policy and screening evaluation happens immediately. The transaction transitions to
PENDING_SIGNATURE, PENDING_AUTHORIZATION, PENDING_AML_SCREENING, or REJECTED.Webhook event: transaction.createdQUEUED
QUEUED
Held briefly because of an idempotency conflict (a duplicate
Idempotency-Key) or a tenant rate limit. The transaction returns to SUBMITTED once a slot is available.PENDING_AML_SCREENING
PENDING_AML_SCREENING
Compliance screening was submitted to the AML provider. The transaction is paused until the provider returns a result.Webhook event:
screening.submittedAPPROVED
APPROVED
An approver has approved the transaction. It immediately transitions to
PENDING_SIGNATURE.Webhook event: approval.decisionPENDING_SIGNATURE
PENDING_SIGNATURE
The transaction is ready for external signing. Call
GET /v1/transactions/{id}/signing_payload to retrieve the digest, sign it with your post-quantum private key, and submit via POST /v1/transactions/{id}/signature.Webhook event: transaction.status_changedThis is the key integration point. See the External signing guide.SIGNED
SIGNED
The signature has been validated against the registered wallet’s public key. The service is assembling the raw signed transaction.
BROADCASTING
BROADCASTING
The signed transaction is being sent to the Quantum Chain network via the node pool.
CONFIRMING
CONFIRMING
The transaction has been broadcast and is awaiting on-chain confirmation. The service polls for the transaction receipt and tracks the confirmation depth.
Terminal states
COMPLETED
COMPLETED
The transaction has reached the required confirmation depth. The
chainTxHash, blockNumber, and confirmedAt fields are populated.Webhook event: transaction.completedREJECTED
REJECTED
A policy denied the transaction (e.g., amount exceeds limit, destination blacklisted) or an approver explicitly rejected it. Check
failureReason for details.FAILED
FAILED
The transaction failed during signing (invalid signature), broadcast (node rejected), or confirmation (reverted on-chain or dropped from mempool). Check
failureReason.Webhook event: transaction.failedCANCELLED
CANCELLED
The transaction was cancelled by the integrator before signing and broadcast. Cancel is only valid from
SUBMITTED, PENDING_AUTHORIZATION, APPROVED, or PENDING_SIGNATURE.BLOCKED
BLOCKED
Compliance screening flagged or blocked the transaction. The transaction never reaches the chain.Webhook event:
screening.blockedHappy path timeline
Here’s what a typical successful transfer looks like (auto-approved, no screening hold):Polling vs. webhooks
You can track transaction status two ways:Polling
Call
GET /v1/transactions/{id} periodically. Simple but adds latency and load.Webhooks (recommended)
Register a webhook endpoint and receive real-time events at every state transition.See the Webhooks guide.