Create Confirmation Token
Mints a single-use, short-lived confirmation token from what the buyer entered on your collection surface: the payment method payload, billing details, and attested save consent. Public and rate-limited — the account_id in the body scopes the token but does not authenticate. Confirm it with POST /payments from your server.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-08-25-2"
Body
The account (biz_) this token is scoped to — the publishable identity.
"biz_xxxxxxxxxxxxxx"
The collected method: type names the payment method, category names the payload shape, and the category-keyed object carries the payload. Wallets are the exception: their payload rides the type key (apple_pay / google_pay). Send exactly the one payload arm the category selects — extra arms are rejected. Redirect-flow methods (category redirect, bank_transfer, voucher, and redirect wallets like cashapp) collect nothing and send no payload arm.
Billing details collected with the method. email is always required; cards additionally require name and an address with line1 and country.
Screen/runtime facts from the buyer's browser (platform, screen dimensions, language, ...) used for authentication ceremonies. Header-derived fields are captured server-side.
Where redirect flows send the buyer, carried onto the confirm that consumes this token.
The save-consent state your surface displayed when the buyer confirmed. Confirm may vault only if attested here.
off_session, on_session, null "off_session"
Response
confirmation token created from a card token intent
Enough of the billing details to raise a customer record and recognise the method — email, name, country and postal code. The street address is collected for the charge but never returned; this endpoint is a display-safe preview.
When the token was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
When the token expires, as an ISO 8601 timestamp. Tokens are single-use and short-lived.
"2026-01-01T12:00:00.000Z"
"ctok_xxxxxxxxxxxxxx"
Always confirmation_token.
"confirmation_token"
Display-only preview of the collected method — never the underlying token.
Save-consent state the element displayed at collection: off_session, on_session, or null. Confirm may vault only if attested here.
"off_session"
pending until it is used, then consumed; expired once its short lifetime elapses. Only a pending token can be charged.
pending, consumed, expired "pending"

