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": "9Qx7r...",
  "blockchain": "solana",
  "fiatAmount": 100,
  "tokenAmount": 100,
  "direction": "onramp",
  "memo": "Test order",
  "optionalPayerAccount": "GbeZPbC8CjHfNb1my4ka8oUJCBZFasCoT422JKztJEWB"
}'
{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "amountInFiat": 100,
  "amountInTokens": 0.5,
  "orderType": "onramp",
  "status": "completed",
  "statusPage": "https://example.com/ramp/order/123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

API key for authentication

Body

application/json
​
orderId
string<uuid>

Order ID

​
bankAccountId
string<uuid>

Bank account ID

​
publicKey
string

Public key

​
blockchain
enum<string>

Blockchain type

Available options:
solana
​
fiatAmount
number

Amount in fiat currency (required for onramp)

​
tokenAmount
number

Total tokens to offramp (required for offramp)

​
direction
enum<string>

Transaction direction

Available options:
onramp,
offramp
​
memo
string | null

Optional memo for the transaction

​
optionalPayerAccount
string | null

Optional payer account for the order fees

Response

Order created successfully

​
orderId
string<uuid>

Unique identifier for the order

​
customerId
string<uuid>

ID of the customer who placed the order

​
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

Amount in fiat currency

​
amountInTokens
number | null

Amount in crypto tokens

​
confirmedTxSignature
string | null

Confirmed transaction signature

​
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

Burn transaction details

​
memo
string | null

Optional memo for the order

​
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
​
statusPage
string<uri>

URL to the order status page

⌘I