Skip to main content
POST

Body

application/json
chain_id
integer
required

The target chain. Chains the relay pays out on: EVM chains except Ethereum (1), Base (8453), Linea (59144), Mantle (5000) and Abstract (2741); Gonka (4444119), Stellar (1100) and TON (1117). A chain is also refused (400) while omni's removal key for it is neither the MPC key nor the one this service holds, since a payout it could not clear would block the receiver's next withdrawals.

Required range: x >= 1
Examples:

1100

1117

137

4444119

receiver
string
required

The withdrawals' receiver: on EVM a 0x address or omni's base58 of its 20 bytes; on Gonka a bech32 address or omni's base58; on Stellar and TON omni's base58 (as get_withdrawals_by_receiver names it).

Example:

"0xe4df1d74122c2a7b14481cbdde704fbd0a4f11a2"

Response

The receiver's job: new, or the active one.

id
string
required

<shard>.<uuid>, or a bare uuid.

origin
enum<string>
required

api: POST /relay/withdraw. refuel: the service's own sweep of stuck withdrawals.

Available options:
api,
refuel
chain_id
integer
required

Chain ids are omni's (v2_1.omni.hot.tg), not always the chain's own: EVM chains use their EIP-155 id (Ethereum 1, Optimism 10, BNB 56, Polygon 137, Monad 143, X Layer 196, Base 8453, Arbitrum 42161, Avalanche 43114, ...); the others have omni's numbers: Solana 1001, NEAR 1010, Stellar 1100, TON 1117 (TON v1, 1111, is dead), Juno 4444118, Gonka 4444119.

Required range: x >= 1
Examples:

1100

1117

137

4444119

receiver
string
required

The receiver as omni keeps it (base58 of its bytes).

Pattern: ^[1-9A-HJ-NP-Za-km-z]+$
status
enum<string>
required
Available options:
queued,
running,
done,
failed
steps
object[]
required
created_at
integer
required

ms.

updated_at
integer
required

ms.

pending
integer

The receiver's pending withdrawals at the last step. Absent before the first.

Required range: x >= 0
detail
string

Why it failed, or what it is waiting for.

reused
enum<string>

Set when no new job was made: active, the receiver's queued or running job; cooldown, its last job, finished within 2 minutes (failed, or already past the withdrawal asked for), or for the refuel sweep within its longer cooldown.

Available options:
active,
cooldown