Skip to main content
GET
/
v1
/
orders
List all orders
curl --request GET \
  --url https://api.kyren.top/v1/orders \
  --header 'x-api-key: <api-key>'
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "order_def456",
        "productId": "prod_abc123",
        "customerEmail": "customer@example.com",
        "customerName": null,
        "amount": "9.99",
        "currency": "USD",
        "platformFeeRate": "0.04",
        "platformFee": "0.40",
        "netAmount": "9.59",
        "settledAmount": "9.59",
        "settledCurrency": "USD",
        "exchangeRate": null,
        "hkdExchangeRate": null,
        "paymentMethod": "CREDIT_CARD",
        "status": "PAID",
        "paidAt": 1736932500000,
        "settledAt": null,
        "metadata": {
          "userId": "user_456"
        },
        "createdAt": 1736932200000
      }
    ],
    "pagination": {
      "page": 1,
      "size": 20,
      "total": 1,
      "totalPages": 1
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your API key. Public production API-key endpoints accept kyren_live_* keys. Staging credentials are environment-specific and must be used only with the staging environment for which Kyren issued them.

Query Parameters

​
status
enum<string>

Filter by order status

  • CREATING — Order is being created while waiting for gateway result
  • PENDING — Order created, awaiting payment confirmation
  • PAID — Payment confirmed
  • SETTLED — Funds settled to merchant balance
  • REFUNDED — Order has been refunded
  • DISPUTED — Order is under dispute
  • CHARGEBACK — Card payment was charged back
  • FAILED — Payment failed
  • CLOSED — Order closed (expired or unpaid)
  • REVOKED — Order has been revoked
Available options:
CREATING,
PENDING,
PAID,
SETTLED,
REFUNDED,
DISPUTED,
CHARGEBACK,
FAILED,
CLOSED,
REVOKED
​
productId
string

Filter by product ID

​
startDate
integer<int64>

Filter orders created on or after this time (Unix timestamp in milliseconds)

​
endDate
integer<int64>

Filter orders created on or before this time (Unix timestamp in milliseconds)

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
size
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

A paginated list of orders

​
code
integer
Example:

0

​
message
string
Example:

"success"

​
data
object