Skip to main content
POST
Expire an order

Authorizations

Authorization
string
header
required

A store API key, sent as Authorization: Bearer <key>. Live keys are prefixed tbrn_live_. Keys are minted per store in the dashboard with an explicit scope set.

Path Parameters

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

Response

The order, now expired.

id
string
required

Public short id — the value that appears in checkout links.

status
enum<string>
required
Available options:
pending,
completed,
partial,
expired
priceAmount
string
required

Fiat amount as a decimal string, e.g. "9.99". Never a number.

priceCurrency
enum<string>
required
Available options:
usd,
eur
successUrl
string | null
required
cancelUrl
string | null
required
customerEmail
string | null
required
extraContext
object | null
required
paymentMethod
enum<string> | null
required
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

Amount in the asset's smallest unit (wei / lamports / token base units), as an integer string.

receivedAmount
string | null
required

Amount in the asset's smallest unit (wei / lamports / token base units), as an integer string.

transactions
object[]
required
items
object[]
required
checkoutUrl
string
required
createdAt
string<date-time>
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
expiresAt
string<date-time>
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completedAt
string<date-time> | null
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$