curl --request GET \
--url https://api.starkfi.io/order/list/clxxxxxxxxxxxxxxxxxxxxxxxx \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/list/${orderId}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.get(
f"https://api.starkfi.io/order/list/{order_id}",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"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"
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
Orders
Get order by ID
Fetch a single payment order that belongs to the authenticated tenant.
GET
/
order
/
list
/
{order_id}
curl --request GET \
--url https://api.starkfi.io/order/list/clxxxxxxxxxxxxxxxxxxxxxxxx \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/list/${orderId}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.get(
f"https://api.starkfi.io/order/list/{order_id}",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"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"
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
string
required
payment_orders.id (CUID).curl --request GET \
--url https://api.starkfi.io/order/list/clxxxxxxxxxxxxxxxxxxxxxxxx \
--header 'x-api-key: <api_key>'
const orderId = "clxxxxxxxxxxxxxxxxxxxxxxxx";
const response = await fetch(
`https://api.starkfi.io/order/list/${orderId}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
order_id = "clxxxxxxxxxxxxxxxxxxxxxxxx"
response = requests.get(
f"https://api.starkfi.io/order/list/{order_id}",
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"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"
}
}
{
"statusCode": 404,
"success": false,
"status": "order_not_found",
"message": "Order not found."
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
Response
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).⌘I
.png?fit=max&auto=format&n=I_v6ul4JDafNKFQP&q=85&s=f0ad25536f8a3ca42331fcff88ab2b26)