Skip to main content
GET
Retrieve Confirmation Token

Autorisations

Authorization
string
header
requis

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.

Scopes

payment:basic:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Confirmation token ID, prefixed ctok_.

Paramètres de requête

account_id
string
requis

The account the token was minted for, prefixed biz_. It must match the token's account.

Réponse

confirmation token retrieved

billing_address
object | null
requis

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_details
object | null
requis

Billing preview supplied at collection: email, name, country and postal code.

created_at
string
requis

When the token was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

expires_at
string
requis

When the token expires, as an ISO 8601 timestamp. Tokens are single-use and short-lived.

Exemple:

"2026-01-01T12:00:00.000Z"

id
string
requis
Exemple:

"ctok_xxxxxxxxxxxxxx"

object
string
requis

Always confirmation_token.

Exemple:

"confirmation_token"

payment_method_preview
object
requis

Display-only preview of the collected method — never the underlying token.

setup_future_usage
string | null
requis

Save-consent state the element displayed at collection: off_session, on_session, or null. Confirm may vault only if attested here.

Exemple:

"off_session"

status
enum<string>
requis

pending until it is used, then consumed; expired once its short lifetime elapses. Only a pending token can be charged.

Options disponibles:
pending,
consumed,
expired
Exemple:

"pending"