Skip to main content
GET
/
ramp
/
order
/
{order_id}
Get order details
curl --request GET \
  --url https://api.etherfuse.com/ramp/order/{order_id} \
  --header 'Authorization: <api-key>'
{
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "amountInFiat": 123,
  "amountInTokens": 123,
  "confirmedTxSignature": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "burnTransaction": "<string>",
  "isAnchorOrder": true,
  "withdrawAnchorAccount": "<string>",
  "withdrawMemo": "<string>",
  "withdrawMemoType": "<string>",
  "memo": "<string>",
  "depositClabe": "<string>",
  "orderType": "onramp",
  "status": "created",
  "statusPage": "<string>",
  "feeBps": 123,
  "feeAmountInFiat": 123,
  "exchangeRate": "<string>",
  "etherfuseMidMarketRate": "<string>",
  "sourceAsset": "<string>",
  "targetAsset": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Pass the key directly (e.g., Authorization: your-api-key). Do not use a Bearer prefix.

Path Parameters

​
order_id
string<uuid>
required

ID of the order to retrieve

Response

Order details retrieved successfully

Order object returned in webhooks and when fetching order details. This is the payload you'll receive in order_updated webhook events.

​
orderId
string<uuid>

Unique identifier for the order

​
customerId
string<uuid>

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

​
createdAt
string<date-time>

Timestamp when the order was created

​
updatedAt
string<date-time>

Timestamp when the order was last updated

​
deletedAt
string<date-time> | null

Timestamp when the order was deleted (if applicable)

​
completedAt
string<date-time> | null

Timestamp when the order was completed

​
amountInFiat
number<decimal> | null

Amount in fiat currency (MXN)

​
amountInTokens
number<decimal> | null

Amount in crypto tokens

​
confirmedTxSignature
string | null

Blockchain transaction hash when crypto transfer is confirmed

​
walletId
string<uuid>

ID of the wallet used for the order

​
bankAccountId
string<uuid>

ID of the bank account used for the order

​
burnTransaction
string | null

Encoded transaction for the user to sign (offramp orders)

​
isAnchorOrder
boolean | null

Whether this order uses anchor mode (Stellar only)

​
withdrawAnchorAccount
string | null

Stellar anchor account address to send payment to (anchor mode only)

​
withdrawMemo
string | null

Base64-encoded hash memo to include in the payment (anchor mode only)

​
withdrawMemoType
string | null

Memo type for anchor payments — always "hash" (anchor mode only)

​
memo
string | null

Optional memo for the order

​
depositClabe
string | null

CLABE number for deposit (onramp orders only)

​
orderType
enum<string>

Type of the order

Available options:
onramp,
offramp
​
status
enum<string>

Current status of the order

Available options:
created,
funded,
completed,
failed,
refunded,
canceled
​
statusPage
string<uri>

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 application.

​
feeBps
integer | null

Fee in basis points (e.g., 20 = 0.20%)

​
feeAmountInFiat
number<decimal> | null

Actual fee amount collected in fiat currency

​
exchangeRate
string | null

Fee-inclusive exchange rate between source and target assets at the time of order creation. This is the rate the user actually received. For example, if a user exchanged MXN for CETES with a fee, this reflects the rate after the fee was applied. Null for historical orders created before this field was added.

​
etherfuseMidMarketRate
string | null

Raw mid-market rate before fees. For stablebond ramps, this is the bond price (e.g., MXN per CETE). For FX ramps, this is the forex mid-market rate between the underlying fiat currencies. Null for historical orders.

​
sourceAsset
string | null

Source asset identifier for this order. For onramps, this is the fiat currency (e.g., "MXN"). For offramps, this is the crypto asset identifier.

​
targetAsset
string | null

Target asset identifier for this order. For onramps, this is the crypto asset identifier. For offramps, this is the fiat currency (e.g., "MXN").