Retrieve Confirmation Token
Retrieves a token’s payment method and billing details — never the underlying payment credential. Public and rate-limited: the account_id query param must match the account the token was minted for. A bearer credential with payment:basic:read on that account also receives the collected billing address.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-10-07-2"
Path Parameters
Confirmation token ID, prefixed ctok_.
Query Parameters
The account (biz_) the token was minted for.
Response
confirmation token retrieved
The collected billing address, including the name on the address. Null when not collected or without bearer authentication with payment:basic:read on the token’s account.
Billing preview supplied at collection: email, name, country and postal code.
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"

