Skip to main content
Once a transaction is created, you typically want to know what kind it is, where it sits in its lifecycle, and how to retrieve it. This page covers the types, the statuses they move through, and the endpoint for listing them.

Transaction types

The signing window

Initiating a transaction (eg. Get withdraw payload, Get deposit payload) creates a draft transaction and returns its transaction_id together with the payload to sign. Until the signature is submitted through Sign a payload, this draft only exists internally - in a created or claimed status the API never returns. It is not listed by List all transactions or List all transactions across every account, and Get single transaction returns 404 Not Found for its ID. Draft transactions are also ephemeral. At most one unsigned draft exists per account: initiating a new transaction discards any previous unsigned draft, and its transaction_id becomes permanently invalid.
Do not persist or poll a transaction_id before Sign a payload has succeeded. Treat the ID returned at creation as valid only for the signing step that immediately follows.
Once the payload is signed, the transaction becomes visible with one of the statuses documented below (withdrawal_initiated, processing, completed, …). A 404 from Get single transaction therefore means one of three things:
  • the ID never existed;
  • it belonged to an unsigned draft that has been superseded by a newer one;
  • the transaction is still inside the brief signing window, and will appear once signed.

Transaction statuses

The transaction status can be checked by calling the Get transaction endpoint. Only signed transactions carry a status - drafts waiting to be signed are not returned by the API at all, as described in the signing window above.
  • waiting_for_funds - The transaction has been signed. The system is waiting for the bank transfer to trigger the broadcasting of the transaction.
  • funds_in_transfer - The funds have been scheduled to arrive with Bridge soon.
  • processing - The funds have arrived with Bridge and are currently being on-ramped. The transaction is being broadcasted.
  • completed - The transaction has been broadcasted and executed. The funds have been transferred to the vault.

Retrieving transactions

Three endpoints are available depending on what you need: a single transaction by ID, all transactions for one account, or every transaction across all your accounts.
Get single transaction returns one transaction by its ID.Query parameters
  • transaction_id - UUID of the transaction.
You can use this to poll the status of a specific transaction (deposit, withdrawal, etc.) after the user has signed it.