ctok_ ID to send to the Payments API from your server. Retrieve a token to display its payment method and billing preview or check whether it is still usable.
Endpoints
Attributes
string
required
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.
string
required
When the token was created, as an ISO 8601 timestamp.
string
required
When the token expires, as an ISO 8601 timestamp. Tokens are single-use and
short-lived.
string
required
Always
confirmation_token.object
required
Display-only preview of the collected method — never the underlying token.
Properties
Properties
string | null
required
The saved payment method this preview came from, or
null when the buyer
supplied a new one.object
Present when the category is
bank_debit. Empty until the account is charged.Properties
Properties
string
Lowercase card brand, such as
visa or mastercard.string
Uniquely identifies this particular card number. Matches the
fingerprint on
any payment method saved from this token, so you can recognize a card across
attempts. For a wallet, this identifies the network token rather than the
underlying card.string
The last four digits of the card.
object
Details of the card, when the category is
card.Properties
Properties
string
Lowercase card brand, such as
visa or mastercard.string
Uniquely identifies this particular card number. Matches the
fingerprint on
any payment method saved from this token, so you can recognize a card across
attempts. For a wallet, this identifies the network token rather than the
underlying card.string
The last four digits of the card.
string
required
The family the type belongs to.Available options:
card, wallet, bank_debit, bank_transfer, voucher, redirect, crypto, balance, in_app_purchase, savedstring
required
Human-readable label for the method, e.g.
Visa •••• 4242.object
Details of the stored card, when the category is
saved. Absent for a balance.Properties
Properties
string
Lowercase card brand, such as
visa or mastercard.string
Uniquely identifies this particular card number. Matches the
fingerprint on
any payment method saved from this token, so you can recognize a card across
attempts. For a wallet, this identifies the network token rather than the
underlying card.string
The last four digits of the card.
string
required
The payment method type, e.g.
card, apple_pay, klarna.object
Details of the network token the wallet supplied, when the category is
wallet.Properties
Properties
string
Lowercase card brand, such as
visa or mastercard.string
Uniquely identifies this particular card number. Matches the
fingerprint on
any payment method saved from this token, so you can recognize a card across
attempts. For a wallet, this identifies the network token rather than the
underlying card.string
The last four digits of the card.
string | null
required
Save-consent state the element displayed at collection:
off_session,
on_session, or null. Confirm may vault only if attested here.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, expiredConfirmationToken

