Skip to main content
GET
/
order
/
list
/
{order_id}
curl --request GET \
  --url https://api.starkfi.io/order/list/clxxxxxxxxxxxxxxxxxxxxxxxx \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "order_found",
  "message": "Order found successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "tenant_id": "...",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "active": true,
    "payment_session_link": "https://app.starkfi.io/sessions/payment?code=...",
    "order_created_at": "2025-01-01T12:00:00.000Z",
    "order_updated_at": "2025-01-01T12:00:00.000Z"
  }
}
​
x-api-key
string
required
Your StarkFi API key. You can find it in your dashboard.
​
order_id
string
required
payment_orders.id (CUID).
curl --request GET \
  --url https://api.starkfi.io/order/list/clxxxxxxxxxxxxxxxxxxxxxxxx \
  --header 'x-api-key: <api_key>'

{
  "statusCode": 200,
  "success": true,
  "status": "order_found",
  "message": "Order found successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "tenant_id": "...",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "active": true,
    "payment_session_link": "https://app.starkfi.io/sessions/payment?code=...",
    "order_created_at": "2025-01-01T12:00:00.000Z",
    "order_updated_at": "2025-01-01T12:00:00.000Z"
  }
}

​
Response

​
data
object
required
Full payment_orders record when success is true (includes JSON fields such as order_items, split_payment_config, payment_method_allowed when set).