POS API / Orders

Get Order

Retrieve the full details and current status of a specific POS order.

GET {{base_url}}/orders/{order_id}

Path Parameters

Field Type Details
order_id string required — The POS order ID (e.g. POS-20240115-A1B2C3)

Auto-expiry: If the order is still PENDING and past its expires_at, the API will automatically mark it as EXPIRED before returning.

Response Fields

Field Description
order_id Unique POS order identifier
amount Formatted amount with currency (e.g. '25.00 EUR')
raw_amount Numeric amount value
status PENDING, PAID, EXPIRED, CANCELLED, REFUNDED, REFUND_PENDING
qr_data QR code data string (when payment_method includes qr)
payment_url Hosted payment page URL (when payment_method includes page)
trx_id Quickei transaction ID (null until paid)
paid_at ISO 8601 timestamp of payment (null until paid)

Example Request

GET /merchant-api/pos/v1/orders/POS-20240115-A1B2C3
Authorization: Basic {base64_credentials}

Success Response 200

{
  "message": {
    "success": ["Order status retrieved"]
  },
  "data": {
    "order_id": "POS-20240115-A1B2C3",
    "amount": "25.00 EUR",
    "raw_amount": 25.00,
    "currency": "EUR",
    "payment_method": "both",
    "reference": "INV-2024-001",
    "description": "Table 5 - Lunch",
    "terminal_id": "terminal-01",
    "status": "PAID",
    "qr_data": "quickei://pay?order=POS-20240115-A1B2C3&a=25.00&c=EUR",
    "payment_url": "https://quickei.com/pay/pos/POS-20240115-A1B2C3",
    "trx_id": "TRX-98765",
    "paid_at": "2024-01-15T14:02:30+00:00",
    "expires_at": "2024-01-15T14:05:00+00:00",
    "created_at": "2024-01-15T14:00:00+00:00"
  }
}

Error Response 404

{
  "message": {
    "error": ["Order not found"]
  }
}