Skip to main content
GET
Retrieve an order

Authorizations

Authorization
string
header
required

A store API key, sent as Authorization: Bearer <key>.

A key looks like tbrn_live_ followed by 48 hex characters, e.g. tbrn_live_4f2a...c91b. Mint one in the Taberna dashboard under Developers → API Keys, tick the scopes the integration needs, and copy it there and then — the full value is shown once and only its hash is stored, so a lost key is replaced rather than recovered.

One key belongs to one store and carries a fixed scope set. Send it from a server, never from a browser: it can create orders and invoices and read every order the store has.

Path Parameters

id
string
required

The order to act on. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{21,22}$
Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

Response

The order.

An order as the merchant API reports it.

id
string
required

The order's id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

status
enum<string>
required

Where the order is in its lifecycle. pending — created, waiting for the buyer to pay. completed — paid in full; any digital delivery has been released. partial — funds arrived but fell short of the locked quote. expired — the payment window closed without full payment, and any reserved stock went back to the pool.

Available options:
pending,
completed,
partial,
expired
Example:

"pending"

priceAmount
string
required

Total the buyer owes. Decimal string in the resource's fiat currency, e.g. "49.99" — a string, never a JSON number, so no precision is lost in transit.

Example:

"49.99"

priceCurrency
enum<string>
required

The fiat currency every amount on this resource is priced in. Crypto is quoted against it at payment time.

Available options:
usd,
eur
Example:

"usd"

successUrl
string | null
required

Where the hosted checkout sends the buyer after a successful payment. Null when none was set at creation.

Example:

"https://example.com/thanks"

cancelUrl
string | null
required

Where the hosted checkout sends the buyer if they back out. Null when none was set at creation.

Example:

"https://example.com/cart"

customerEmail
string | null
required

Buyer email for the receipt and any digital delivery, either supplied at creation or entered on the checkout page. Null when neither happened.

Example:

"buyer@example.com"

extraContext
object | null
required

The arbitrary JSON object you attached at creation, returned untouched. Taberna never interprets it — use it to carry your own order or user reference.

Example:
paymentMethod
enum<string> | null
required

The token and chain the buyer pays with, named <asset>_<chain>; a bare sol, eth, matic or bnb is that chain's native coin. So usdc_base is USDC on Base and eth is ether on Ethereum mainnet. The matic key is Polygon's native coin, now called POL — the key keeps its original name and does not change. Null until the buyer picks one.

Available options:
sol,
usdc_solana,
eth_base,
usdc_base,
usdt_base,
eth,
usdc_ethereum,
usdt_ethereum,
matic,
usdc_polygon,
usdt_polygon,
bnb,
usdt_bnb
cryptoAmount
string | null
required

The quoted amount for the attempt this order is reported against. Null until the buyer starts one. Integer string in the asset's own smallest unit, NOT a decimal token amount: lamports for SOL (1 SOL = "1000000000"), wei for ETH/POL/BNB (1 ETH = "1000000000000000000"), base units for USDC/USDT (1 USDC = "1000000").

receivedAmount
string | null
required

How much of that quote actually arrived. Integer string in the asset's own smallest unit, NOT a decimal token amount: lamports for SOL (1 SOL = "1000000000"), wei for ETH/POL/BNB (1 ETH = "1000000000000000000"), base units for USDC/USDT (1 USDC = "1000000").

transactions
object[]
required

On-chain transfers for the payment attempt this order is reported against. Empty until funds are seen.

items
object[]
required

The products bought, one entry per line.

checkoutUrl
string
required

The hosted checkout page to send the buyer to. Safe to share; it is what the short id unlocks.

Example:

"https://taberna.io/checkout/7Kq2mVn8pRt3XwYz5Bd4L"

createdAt
string<date-time>
required

When the order was created. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"

expiresAt
string<date-time>
required

When the order stops accepting payment. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"

completedAt
string<date-time> | null
required

When the order was paid in full. Null until it is. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"