Skip to main content
GET
Retrieve Confirmation Token

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-25-2"

Path Parameters

id
string
required

Confirmation token ID, prefixed ctok_.

Query Parameters

account_id
string
required

The account (biz_) the token was minted for.

Response

confirmation token retrieved

billing_details
object | null
required

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.

created_at
string
required

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

Example:

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

expires_at
string
required

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

Example:

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

id
string
required
Example:

"ctok_xxxxxxxxxxxxxx"

object
string
required

Always confirmation_token.

Example:

"confirmation_token"

payment_method_preview
object
required

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

setup_future_usage
string | null
required

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

Example:

"off_session"

status
enum<string>
required

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

Available options:
pending,
consumed,
expired
Example:

"pending"