Skip to main content
POST
/
order
/
create
curl --request POST \
  --url https://api.starkfi.io/order/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "payment_method_allowed": {
      "crypto": true,
      "pixcrypto": true
    }
  }'

{
  "statusCode": 200,
  "success": true,
  "status": "order_created",
  "message": "Order created successfully.",
  "data": {
    "order_id": "clxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
​
x-api-key
string
required
Your StarkFi API key. You can find it in your dashboard.
​
executor_id
string
required
Caller identifier for this template (e.g. api_transaction).
​
from_currency_symbol
string
required
Source fiat symbol enabled for your account (validated server-side), e.g. BRL, USD.
​
amount_from
string
required
Amount in the source currency (decimal string), e.g. "100.00".
​
to_currency_symbol
string
required
Destination crypto symbol, e.g. USDT, USDC.
​
on_ramp
boolean
required
Whether this order represents an on-ramp flow.
​
gateway_method
enum<string>
required
Processing mode: direct (one-off) or subs (subscription-capable template).
​
payment_method_allowed
object
Optional flags; when provided, at least one must be true: crypto, pixcrypto, cardcrypto, cardfiat, cryptofiat.
​
order_items
array
Optional line items.
​
split_payment_config
array
Optional split configuration.
​
subscription_payment_config
object
Optional subscription defaults.
curl --request POST \
  --url https://api.starkfi.io/order/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "payment_method_allowed": {
      "crypto": true,
      "pixcrypto": true
    }
  }'

{
  "statusCode": 200,
  "success": true,
  "status": "order_created",
  "message": "Order created successfully.",
  "data": {
    "order_id": "clxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

​
Response

​
statusCode
number
required
HTTP status mirrored in the body (200 on success).
​
success
boolean
required
Whether the request succeeded.
​
status
string
required
Machine-readable code, e.g. order_created.
​
message
string
required
Human-readable message.
​
data
object
Present on success.