Skip to main content
GET
Read one of your orders by reference

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Path Parameters

order_ref
string
required
Pattern: ^ord_[A-Za-z0-9][A-Za-z0-9_-]*$

Response

the client's order (non-PHI projection)

The non-PHI view of one of your orders — a closed, minimum-necessary set: order reference, brand, offering, status, exact amount in minor units, currency, and timestamps. It never includes patient identity (name, email, phone, address), medical information, card data, a payment reference, or any secret. It reports the order; it does not move money.

brand_id
string
required

the client's brand this order belongs to — the account table's grouping/filter key

created_at
string<date-time>
required

order creation timestamp

currency
string
required
Pattern: ^[A-Z]{3}$
offering_ref
string
required

the offering (SKU-family) this order was placed against

order_ref
string
required
state
enum<string>
required
Available options:
created,
payment_authorized,
paid,
payment_failed,
partially_refunded,
refunded,
disputed,
cancelled
total_minor
integer
required

order total, integer minor units (never a float) — money-SHAPED, not moved

updated_at
string<date-time>
required

last-modification timestamp — advances on every state change. The RECONCILIATION watermark: sort key + the updated_since filter target, so a client can catch up after a missed webhook window.