Docs › Build with Beluga › API reference › Bridge orders

Get order

Current state of a deposit or redemption.

GET/api/order/{id}

Poll every 10 seconds or slower and stop at a final state (completed, expired, refunded). The order ID is the only access credential, so treat it like a receipt number. States and transitions: Order lifecycle.

Path parameters

Name	Type	Description
`id`required	string	Order ID: 6–20 characters, letters, digits, `-` and `_`.

Responses

200The order.

Field	Type	Description
`id`	string	Order ID.
`kind`	string	`deposit` or `withdraw`.
`state`	string	See states.
`hlAddress`	string \| null	Deposit: XMR2 recipient. Redemption: `null`.
`xmrAddress`	string \| null	Redemption payout address.
`depositAddress`	string \| null	Deposit: one-time Monero subaddress (null while `new`). Redemption: the order's own Hyperliquid address.
`amountIn`	string \| null	Received, atomic units (10¹²): XMR for deposits, XMR2 for redemptions.
`amountOut`	string \| null	Sent, atomic units: XMR2 credited or XMR paid.
`fee`	string	Fee, atomic units (`"0"` for deposits).
`confirmations`	integer	Deposit confirmations (of the least-confirmed transfer).
`confsNeeded`	integer \| null	Confirmations this deposit needs before XMR2 is sent: 5 below 200 XMR, else 10 (`null` for withdrawals).
`inTx`	string \| null	Incoming Monero txid(s), comma-separated, or Hyperliquid hash.
`outTx`	string \| null	Outgoing Hyperliquid hash or Monero txid.
`createdAt / expiresAt`	string \| null	ISO 8601 timestamps; `expiresAt` is the funding deadline.

404Unknown order ID.

{
  "error": "not found"
}

429Rate limit reached; retry after the current minute.

{
  "error": "rate limit"
}