Get order

Retrieves details for a specific order accessible to your API key.

GET /ramp/order/{order_id}

Get order

cURL

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/order/{order_id} \
  --header 'Authorization: <api-key>'

200

{
  "amountInFiat": "1000.00",
  "amountInTokens": "58.42",
  "bankAccountId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "blockchain": "stellar",
  "completedAt": "2026-05-02T09:16:30Z",
  "createdAt": "2026-05-02T09:15:00Z",
  "customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "depositAccountHolder": "Etherfuse MX",
  "depositBankName": "Example Bank",
  "depositClabe": "646180157000000004",
  "etherfuseMidMarketRate": "17.15",
  "exchangeRate": "17.12",
  "feeAmountInFiat": "2.00",
  "feeBps": 20,
  "orderId": "7b9c1e2d-3f4a-5b6c-7d8e-9f0a1b2c3d4e",
  "orderType": "onramp",
  "sourceAsset": "MXN",
  "status": "completed",
  "statusPage": "https://app.etherfuse.com/ramp/order/7b9c1e2d-3f4a-5b6c-7d8e-9f0a1b2c3d4e",
  "stellarClaimTransaction": "AAAAAgAAAABk...base64_xdr...",
  "stellarClaimableBalanceId": "00000000abc1230000000000000000000000000000000000000000000000000000",
  "targetAsset": "USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
  "updatedAt": "2026-05-02T09:16:30Z",
  "walletId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}

Authorizations

Authorization · string · header · required

API key sent in the Authorization header.

Path Parameters

order_id · string<uuid> · required

The order ID

Response

200

application/json

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. The page requires an Etherfuse sign in with an account in the order's organization or its parent organization.

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, avalanche

burnTransaction · string | null

Encoded transaction for the user to sign (bring-your-own-wallet offramp orders). Embedded wallets omit this and instead surface approval on the order; sign via POST /ramp/order/{order_id}/approvals. See Embedded Wallets.

completedAt · string<date-time> | null

Timestamp when the order was completed.

confirmedTxSignature · string | null

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

trackingCode · string | null

SPEI tracking key (clave de rastreo) for the order's fiat transfer. On onramps this is the incoming deposit's clave; on offramps it is the outgoing payout's clave. Present once the SPEI transfer settles — use it to look up the CEP (Comprobante Electrónico de Pago) receipt. Absent until then.

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

Name of the bank that holds the deposit CLABE.

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.

approval · object | null

Pending embedded-wallet approval. Present only when the order is awaiting the owner's signature. The owner signs approvalMessage and submits it to POST /ramp/order/{order_id}/approvals. Re-read the order right before signing: approvalMessage embeds a timestamp that re-mints on each read. Delivered on the order read, the order_updated webhook, and the WebSocket stream.

Show child attributes

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)