Retrieve a checkout
The hosted checkout payload for an order or an invoice, discriminated by type. This is what the payment page polls while an attempt is live.
activeAttempt carries the locked quote, the deposit address and the confirmation progress while a quote is in flight, and is null once it lapses — the buyer picks a token again for a fresh one. An order’s per-item delivery appears only once the order is completed.
Unauthenticated: possession of the checkout id is the credential, so send no API key. The id is unguessable and every payload is redacted for a buyer audience.
Path Parameters
^[1-9A-HJ-NP-Za-km-z]{21,22}$Response
The checkout, tagged order or invoice.
- Option 1
- Option 2
"order"Public short id — the value that appears in checkout links.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$pending, completed, partial, expired Fiat amount as a decimal string, e.g. "9.99". Never a number.
usd, eur ISO-8601 timestamp in UTC.
^(?:(?:\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))$ISO-8601 timestamp in UTC.
^(?:(?:\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))$