Skip to main content
GET
Get order details

Authorizations

Authorization
string
header
required

Send Authorization: <ApiKey>:<ApiSecret> — joined by a colon, raw. No Bearer prefix, no base64.

Get your credentials

Path Parameters

houdiniId
string
required
Maximum string length: 64

Response

Success

houdiniId
string
required

Public order id. Use it with Get order details.

expires
string<date-time>
required

Deposit deadline — send the funds by this time or the order expires. Not a rate lock.

displayStatus
enum<string>
required

Human-readable state for your UI, derived from status and the leg statuses. Prefer this over status.

Available options:
WAITING_FOR_DEPOSIT,
DEPOSIT_DETECTED,
EXCHANGE_IN_PROGRESS,
SENDING_TO_INTERMEDIARY,
REACHED_INTERMEDIARY,
INITIATING_SECOND_EXCHANGE,
SECOND_EXCHANGE_IN_PROGRESS,
SENDING_TO_RECEIVER,
SWAP_COMPLETED,
EXPIRED,
FAILED,
REFUNDED,
DELETED
status
enum<number>
required

Numeric order state. For anything user-facing prefer displayStatus.

  • -2 initializing
  • -1 created
  • 0 waiting for your deposit
  • 1 confirming your deposit
  • 2 exchanging
  • 3 anonymizing — private swaps only
  • 4 finished
  • 5 expired
  • 6 failed
  • 7 refunded
  • 8 deleted
Available options:
-2,
-1,
0,
1,
2,
3,
4,
5,
6,
7,
8
eta
number<double>
required

ETA time, depending on swap

inAmount
number<double>
required

Amount to deposit, in the input token.

inSymbol
string
required

Symbol of the input token, e.g. BTC.

outAmount
number<double>
required

Amount you receive, in the output token.

outSymbol
string
required

Symbol of the output token, e.g. ETH.

inAmountUsd
number<double>
required

USD value of the input amount at order creation time.

outAmountUsd
number<double>
required

outAmount valued in USD.

inToken
object
required

Token you sent.

outToken
object
required

Token you received.

receiverAddress
string
required

Wallet the payout is sent to.

anonymous
boolean
required

True when this order took the private two-leg route.

isDex
boolean
required

True when the order executed on a DEX route.

actionRequired
boolean
required

True when the order failed but your deposit had already arrived — contact support to recover the funds.

inStatus
enum<number>
required

Progress of the incoming leg — your deposit reaching the provider. For reference and debugging; drive your UI from displayStatus instead.

  • 0 created
  • 1 waiting for the deposit
  • 2 deposit seen, waiting for confirmations
  • 3 exchanging
  • 4 sending funds on
  • 5 finished
  • 6 failed
  • 7 refunded
  • 8 on hold for a compliance check
  • 9 expired — no deposit arrived in time
  • 10 finished through a fallback payout
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
created
string<date-time>
required
inCreated
string<date-time>
required

When the incoming leg was created.

notified
boolean
required
id
string
required
fixed
boolean

True when the order settled at a locked rate.

refundAddress
string

Refund address recorded for this order.

depositTag
string

Memo/tag that must be sent with the deposit, on chains that use one (XRP, TON, Stellar, …).

Show it to your user next to depositAddress — a deposit sent without it may not be credited.

nonRefundable
boolean

True when the deposit can no longer be refunded.

rerouted
boolean

True when the route that executed is not the one that was quoted, because the quoted route failed and a fallback was used. The amounts may differ from the quote — compare inAmount against quotedInAmount and outAmount against quotedOutAmount.

quotedInAmount
number<double>

The deposit amount originally quoted, present only when the order was rerouted. inAmount is what the fallback route actually asks for; on an exact-out order this is the side that moves.

quotedOutAmount
number<double>

The payout originally quoted, present only when the order was rerouted. outAmount is what the fallback route will actually pay; on an exact-in order this is the side that moves.

refundHash
string

Hash of the transaction that returned your funds. Absent unless the order refunded.

refundChain
string

Chain the refund was returned on, e.g. "bsc". Refunds are returned on the input chain.

refundAmount
number<double>

Amount returned to you, after the provider's refund fee. Absent when the exchange did not report one.

modified
string<date-time>
metadata
any

Extra data from the provider. The shape depends on the route.

receiverTag
string | null

Memo/tag required when receiving funds for assets that use one

swapName
string

Name of the exchange handling the deposit leg. Omitted on private orders, which withhold the provider, and on multiswap orders that have not yet been assigned one.

multiId
string

Multi ID. Present only on orders created as part of a batch.

outStatus
enum<number>

Status of the payout leg. Present only on private orders — public orders settle in a single leg and never carry one. For reference and debugging; drive your UI from displayStatus instead.

  • 0 created
  • 1 waiting for the deposit
  • 2 deposit seen, waiting for confirmations
  • 3 exchanging
  • 4 sending funds on
  • 5 finished
  • 6 failed
  • 7 refunded
  • 8 on hold for a compliance check
  • 9 expired — no deposit arrived in time
  • 10 finished through a fallback payout
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
outTransactionOutHash
string

Payout transaction hash of the second leg. Present only on private orders, and only once that leg has paid out. Public orders report their payout hash on inTransactionOutHash instead.

orderFinishedReceived
string<date-time>

When the order reached a final state. Stamped only when an order finishes — orders that expire, fail or refund never receive one.

depositAddress
string

The deposit address where the user must send funds. Omitted on multiswap orders whose per-order setup did not complete.