Skip to main content
POST
Create Agent Checkout
Agent Checkouts is available in production only. A staging API key gets 403 with the message "Agent Checkouts is only available in production". See Test in Production.

Authorizations

X-API-KEY
string
header
required

API key required for authentication

Authorization
string
header
required

The end user's JWT, sent as Authorization: Bearer <JWT> together with a client-side API key. Validated against the project's external JWT configuration.

Headers

x-crossmint-user-id
string

Server-side subject to act on behalf of. Ignored for client-side user auth.

Body

application/json
constraints
object
required
request
object
required
browser
object

Browser profile and requested location, or a caller-owned browser; provide at least one property. A CDP connection excludes the other properties

buyerProfileId
string
Pattern: ^([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)$
merchantGuidance
string
Required string length: 1 - 20000

Response

The checkout run was accepted.

browser
object | null
required
createdAt
string
required
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))$
input
object
required
reason
enum<string>
required
Available options:
accounting_unavailable,
browser_location_unsupported,
browser_session_lost,
cancelled,
cost_limit,
input_expired,
model_error,
reconciliation_required,
runtime_error
revision
integer
required

Monotonically increasing version of this run snapshot. When combining polling and stream updates, retain the snapshot with the greatest revision; values may skip and have no meaning beyond ordering

Required range: 0 <= x <= 9007199254740991
runId
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
failed