curl --request GET \
--url 'https://api.starkfi.io/order/list?page=1&limit=20' \
--header 'x-api-key: <api_key>'
const params = new URLSearchParams({ page: "1", limit: "20" });
const response = await fetch(
`https://api.starkfi.io/order/list?${params}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
response = requests.get(
"https://api.starkfi.io/order/list",
params={"page": 1, "limit": 20},
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "orders_listed",
"message": "Orders listed successfully.",
"data": {
"orders": [],
"pagination": {
"total": 0,
"page": 1,
"limit": 20,
"total_pages": 0
}
}
}
{
"statusCode": 400,
"success": false,
"status": "invalid_parameters",
"message": "Number must be greater than 0"
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
Orders
List orders
Paginated list of payment orders for the authenticated tenant, newest first.
GET
/
order
/
list
curl --request GET \
--url 'https://api.starkfi.io/order/list?page=1&limit=20' \
--header 'x-api-key: <api_key>'
const params = new URLSearchParams({ page: "1", limit: "20" });
const response = await fetch(
`https://api.starkfi.io/order/list?${params}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
response = requests.get(
"https://api.starkfi.io/order/list",
params={"page": 1, "limit": 20},
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "orders_listed",
"message": "Orders listed successfully.",
"data": {
"orders": [],
"pagination": {
"total": 0,
"page": 1,
"limit": 20,
"total_pages": 0
}
}
}
{
"statusCode": 400,
"success": false,
"status": "invalid_parameters",
"message": "Number must be greater than 0"
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
number
Page number (default
1, must be ≥ 1).number
Page size (default
20, maximum 100).enum<string>
Filter by
direct or subs.boolean
Filter by on-ramp flag (
true / false).curl --request GET \
--url 'https://api.starkfi.io/order/list?page=1&limit=20' \
--header 'x-api-key: <api_key>'
const params = new URLSearchParams({ page: "1", limit: "20" });
const response = await fetch(
`https://api.starkfi.io/order/list?${params}`,
{ headers: { "x-api-key": "<api_key>" } }
);
const data = await response.json();
import requests
response = requests.get(
"https://api.starkfi.io/order/list",
params={"page": 1, "limit": 20},
headers={"x-api-key": "<api_key>"},
)
data = response.json()
{
"statusCode": 200,
"success": true,
"status": "orders_listed",
"message": "Orders listed successfully.",
"data": {
"orders": [],
"pagination": {
"total": 0,
"page": 1,
"limit": 20,
"total_pages": 0
}
}
}
{
"statusCode": 400,
"success": false,
"status": "invalid_parameters",
"message": "Number must be greater than 0"
}
{
"statusCode": 401,
"success": false,
"status": "customer_not_logged",
"message": "Customer not logged in."
}
Response
array
required
Array of full
payment_orders rows for the tenant.⌘I
.png?fit=max&auto=format&n=I_v6ul4JDafNKFQP&q=85&s=f0ad25536f8a3ca42331fcff88ab2b26)