Get order - Etherfuse API

Authorizations

Authorization

string

header

required

API key sent in the Authorization header.

Path Parameters

order_id

string<uuid>

required

The order ID

Response

The order

Order representation for WebSocket messages

bankAccountId

string<uuid>

required

ID of the bank account used for the order.

createdAt

string<date-time>

required

Timestamp when the order was created.

customerId

string<uuid>

required

Organization ID associated with the order. In webhook payloads, this is the recipient organization's ID.

orderId

string<uuid>

required

Unique identifier for the order.

orderType

enum<string>

required

Type of the order (onramp/offramp/swap).

Available options:

onramp,

offramp

status

enum<string>

required

Current status of the order. For offramps, completed means fiat has been sent to the customer; finalized means the reversal window has passed and the funds can no longer be returned.

Available options:

created,

funded,

completed,

failed,

refunded,

canceled,

finalized

statusPage

string

required

URL to an Etherfuse-branded page where the customer can view order status and sign transactions (for offramps). Can be used as an alternative to handling transaction signing in your own application.

updatedAt

string<date-time>

required

Timestamp when the order was last updated.

walletId

string<uuid>

required

ID of the wallet used for the order.

amountInFiat

string | null

Amount in fiat currency (e.g. MXN).

amountInTokens

string | null

Amount in crypto tokens.

blockchain

null | enum<string>

Blockchain the order settles on.

Available options:

stellar,

solana,

base,

polygon,

monad

burnTransaction

string | null

Encoded transaction for the user to sign (offramp orders).

completedAt

string<date-time> | null

Timestamp when the order was completed.

confirmedTxSignature

string | null

Blockchain transaction hash, set once the crypto transfer is confirmed.

deletedAt

string<date-time> | null

Timestamp when the order was deleted (if applicable).

depositAccountHolder

string | null

Account holder name for the deposit CLABE. Hardcoded to Etherfuse MX for now.

depositBankName

string | null

Bank that holds the deposit CLABE. Hardcoded to STP for now (all CLABEs are STP proxy accounts).

depositClabe

string | null

CLABE number for deposit (onramp orders only).

etherfuseMidMarketRate

string | null

Raw mid-market rate before fees

exchangeRate

string | null

Fee-inclusive exchange rate between source and target assets

feeAmountInFiat

string | null

Quoted fee amount in fiat currency, derived from fee_bps × order amount.

feeBps

integer<int32> | null

Fee in basis points (e.g., 20 = 0.20%). Always present when order was created with a quote.

Required range: x >= 0

isAnchorOrder

boolean | null

Whether this is an anchor order (SEP-24 mode — no pre-signed TX)

memo

string | null

Optional memo for the order.

partnerFeeAmountFiat

string | null

Partner fee amount collected in fiat currency, derived from the total fee using the partner fee ratio.

partnerFeeBps

integer<int32> | null

Partner fee in basis points applied to this order (e.g. 100 = 1.00%). Only present when a partner fee was configured at quote time.

partnerFeeStatus

string | null

Disbursement status of the partner fee. Only present when partnerFeeBps > 0: none — order not yet completed; pending — order completed, fee awaiting offline disbursement; disbursed — partner fee has been paid out.

sourceAsset

string | null

Source asset identifier. For onramps this is the fiat currency (e.g. MXN); for offramps it is the crypto asset identifier.

stellarClaimTransaction

string | null

Unsigned XDR (base64) for the claim TX (ChangeTrust + ClaimClaimableBalance). The user signs this and submits to Horizon to receive their tokens.

stellarClaimableBalanceId

string | null

Stellar claimable balance ID (hex). Present when tokens were delivered via claimable balance. The user must sign a claim TX to receive their tokens.

targetAsset

string | null

Target asset identifier. For onramps this is the crypto asset identifier; for offramps it is the fiat currency (e.g. MXN).

withdrawAnchorAccount

string | null

Anchor destination account for SEP-24 anchor offramps

withdrawMemo

string | null

Memo to include in the anchor payment (derived from transaction_id)

withdrawMemoType

string | null

Memo type for the anchor payment (always "hash" for anchor orders)