Skip to main content
POST
Create UCP Checkout Session

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Headers

UCP-Agent
string
required

UCP agent identity, for example agent.example/1.0.

Maximum string length: 240
Idempotency-Key
string

Optional idempotency key for safe retries.

Maximum string length: 180

Body

application/json
line_items
object[]
required
Required array length: 1 - 100 elements
buyer
object
fulfillment
object
payment
object
payment_rail
enum<string>
default:acp_stripe
Available options:
acp_stripe,
x402
metadata
object

Response

UCP checkout session created.

ucp
object
required
id
string
required
line_items
object[]
required
status
enum<string>
required
Available options:
ready_for_complete,
completed,
canceled
currency
string
required
totals
object[]
required
buyer
object
fulfillment
object
payment
object
order
object
settlement
object