Home API Reference Retrieve orders

Retrieve orders

Last updated on Jun 07, 2026

List your orders, or fetch a single order to check its status and result.

List orders

curl -H "x-api-key: sk_prod_your_key_here" \
  "https://api.palcards.ps/order?ps=20&status=success"

GET /order — you only ever see your own orders.

Query parameters

Param Type Description
orderType string chargingCard, topUp, or manual
status string[] Filter by status (repeatable)
startDate / endDate string Date range (ISO 8601)
pn number Page number
ps number Page size

Filter by multiple statuses by repeating the param: ?status=success&status=failed.

Response (paginated)

{
  "pageNumber": 1,
  "pageSize": 20,
  "total": 137,
  "data": [
    { "id": 9001, "status": "success", "type": "chargingCard", "clientOrderRef": "ref-0001", "createdAt": "2026-06-07T12:00:00.000Z" }
  ]
}

Get one order

curl -H "x-api-key: sk_prod_your_key_here" \
  "https://api.palcards.ps/order/9001"

GET /order/{id}

Response (single order)

{
  "id": 9001,
  "status": "success",
  "type": "chargingCard",
  "orderCurrency": "USD",
  "clientOrderRef": "your-ref-0001",
  "soldItem": { "id": 7001, "voucher": { "code": "…", "pin": "…" } },
  "customer": { "phone": "+97059…" },
  "appliedDealerPrices": { "price": 9.5, "discount": 0.5, "discountPercent": 5 },
  "createdAt": "2026-06-07T12:00:00.000Z",
  "updatedAt": "2026-06-07T12:00:03.000Z"
}
  • Poll this endpoint to follow an order to a terminal status — or use a webhook to avoid polling. See Order status lifecycle.
  • For vouchers, the delivered card is in soldItem ({ id, voucher: { code, pin } }) when status is success.