Skip to main content
GET
List all orders

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