Skip to main content
POST
Create an order

Authorizations

Authorization
string
header
required

Your API key (cb_live_…), sent as a bearer token, with the scope nft:orders. Keep it on your servers: never in a browser, app or wallet. Use a separate key per environment. A request from a country on our sanctions list gets a 403 with Access denied, whether or not it has a valid key. See Authentication and keys.

Scopes

nft:orders

Headers

Idempotency-Key
string
required

Your own order id, 8-128 characters of A-Za-z0-9_-, one per order. It becomes the order's order_id. Retry a timed-out or 500 call with the same key. The same key with a different request (pack_type, category, resolved odds, quantity, recipient, refund_address) is 422.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

application/json
pack_type
string
required

A pack_type from List packs.

recipient
string
required

The customer's self-custody wallet on your mint chain. Never an exchange deposit address: the NFTs are minted to it.

category
enum<string>
default:pokemon

goods packs hold streetwear and jewelry. Raw singles have no category of their own: they come out of other categories' packs.

Available options:
pokemon,
onepiece,
sports,
riftbound,
watches,
goods
odds
enum<string>

One the pack sells. Default: the pack's default_odds.

Available options:
standard,
hot,
chill,
classic
quantity
integer
default:1

2 or more makes a multi-pack order.

Required range: 1 <= x <= 10
refund_address
string

An EVM wallet that can receive USDC on Base, for refunds. Required on a Solana program; defaults to recipient on an EVM program.

partner_user_ref
string

Your opaque user id. Never put personal data here. Not compared on an idempotent replay.

Pattern: ^[A-Za-z0-9_.:-]{1,128}$

Response

A replay of an earlier request with the same Idempotency-Key (idempotent_replay is true). Nothing new is created and nothing is charged twice.

order
object
required

A multi-pack order (quantity 2-10), paid with one payment.

payment
object
required

A Unifold Payment Intent for exactly the amount due. Open it in your app with client_secret and publishable_key (Unifold's web or React Native SDK), or show deposit_addresses and amount. Paid once at least 99% has arrived. Payments.

idempotent_replay
boolean

Present on a replay.