Skip to main content
GET
Get order status

Authorizations

Authorization
string
header
required

Partner API key in the form Authorization: Bearer fn_....

Query Parameters

id
string
quoteId
string
includeShieldedFunding
enum<string>

Independent opt-in with id or quoteId. Includes private-account aggregate funding progress, including order:null before materialization. Does not change includeFunding provider outcomes.

Available options:
true
includeFunding
enum<string>

Quote selector only. Include retained provider outcomes and allow order:null when a report exists before order creation. Unfunded/unknown quotes still return 404.

Available options:
true
txHash
string
sourceChain
enum<string>
Available options:
arbitrum,
arc,
avalanche,
base,
bitcoin,
bsc,
ethereum,
hedera,
hypercore,
hyperevm,
lightning,
litecoin,
monad,
monero,
optimism,
plasma,
polygon,
robinhood,
sei,
solana,
spark,
tempo,
ton,
tron,
xrp,
zcash
readToken
string

Matching read token for client-key lookups by id or quoteId.

Response

Order status

order
object
required

Null when explicit includeFunding or includeShieldedFunding resolves pre-operation funding.

stages
object[]
required
funding
object[]
fundingStatus
enum<string>

Only with includeShieldedFunding=true.

Available options:
awaiting_payment,
detected,
confirming,
ready,
provider_funding,
provider_processing,
settling,
delivering,
completed,
recovery_required,
refunding,
refunded
fundingDetails
object

Aggregate zatoshi amounts only; no private receipt or transaction identities.