Skip to main content
POST
/
ramp
/
order
Create a new order
curl --request POST \
  --url https://api.etherfuse.com/ramp/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "bankAccountId": "123e4567-e89b-12d3-a456-426614174001",
  "publicKey": "GDUKMGUGD3V6VXTU2RLAUM7A2FABLMHCPWTMDHKP7HHJ6FCZKEY4PVWL",
  "quoteId": "844393ca-be57-4817-a58a-5b60e2792c06"
}
'
{
  "onramp": {
    "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "depositClabe": "<string>",
    "depositAmount": 123
  }
}

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.

Body

application/json
​
orderId
string<uuid>
required

Client-generated order ID

​
bankAccountId
string<uuid>
required

Bank account ID for the fiat leg

​
quoteId
string<uuid>
required

Quote ID from a previous /ramp/quote call. The order will use the blockchain, direction, and amounts from the quote.

​
publicKey
string | null

Customer's crypto wallet address. Required if cryptoWalletId is not provided.

​
cryptoWalletId
string<uuid> | null

UUID of a registered crypto wallet. If provided, publicKey is optional and will be resolved from the wallet record.

​
memo
string | null

Optional memo for the transaction

​
useAnchor
boolean
default:false

When true, the order uses anchor mode (Stellar only). Instead of returning a pre-signed burnTransaction, the response includes withdrawAnchorAccount, withdrawMemo, and withdrawMemoType. Your application builds and submits the payment transaction directly to the anchor account with the provided memo.

Only valid for Stellar offramp orders. Requests with useAnchor: true on non-Stellar blockchains will be rejected.

Response

Order created successfully

Response when creating an order. The response is wrapped in either an "onramp" or "offramp" key depending on the order direction (derived from the quote).

​
onramp
object