Skip to main content
GET
Get checkout — order status, payment state and codes (one poll endpoint)

Authorizations

X-API-Key
string
header
required

API key (wg_live_…) created in the dashboard (Account → API Keys). Shown once at creation; only a hash is stored server-side.

Path Parameters

checkoutId
string
required

Checkout/order id.

Response

Checkout with payment state.

checkoutId
string
required
customerEmail
string
required

The end-customer's email.

status
enum<string>
required

Order lifecycle. partial = some items fulfilled, some failed. expired = never paid.

Available options:
pending,
processing,
completed,
partial,
failed,
expired
totalAmount
number
required

What the end-customer pays, in paymentCurrency (markup included).

paymentCurrency
string
required
items
object[]
required
createdAt
integer<int64>
required

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

payment
object | null
required

Aggregate payment state; null before any payment exists.

externalRef
string | null
markupTotal
number

Your total markup on this checkout, in USD. Credited to your balance as items complete.

sealCards
boolean
callbackUrl
string | null
country
string | null

The customerCountry you supplied.

completedAt
integer<int64> | null

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

expiredAt
integer<int64> | null

Unix timestamp in milliseconds (UTC).

Example:

1753142400000

updatedAt
integer<int64>

Unix timestamp in milliseconds (UTC).

Example:

1753142400000