Skip to main content
GET
Read the payment status of an order

Authorizations

Authorization
string
header
required

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

Headers

X-Brand-Id
string
required

The brand this request is scoped to. It is validated against your authenticated account; an unknown or unauthorized brand is rejected. The brand is never taken from the request body.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

Path Parameters

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

Response

the current payment state of the order

The current payment state of an order. It reflects confirmations received from the payment provider after the patient completes payment. Intended for polling; it does not include the payment token or a fee breakdown.

currency
string
required
Pattern: ^[A-Z]{3}$
order_ref
string
required
payment_state
enum<string>
required
Available options:
created,
payment_authorized,
paid,
payment_failed,
partially_refunded,
refunded,
disputed,
cancelled
total_minor
integer
required