Skip to main content
A Confirmation Token is a single-use, short-lived reference to a payment method and billing details collected from a buyer. Its response contains only a display-safe preview and never returns the underlying payment credential. Create a confirmation token in a buyer-facing collection flow, then send its ctok_ ID 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.

Properties

​
string | null
required
ISO 3166-1 alpha-2 country code.
​
string | null
required
Email supplied when the method was collected.
​
string | null
required
Name on the payment method.
​
string | null
required
Postal or ZIP code.
​
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

​
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. Carries the account’s last four when the linking provider surfaced it.

Properties

​
string
Lowercase card brand, e.g. visa. Absent when the method carries no brand.
​
string
Last four digits of the instrument. Absent when the method carries none.
​
object
Present when the category is card. What the collection surface displayed — the token has not been charged, so this is the buyer’s claim, not the vault’s record.

Properties

​
string
Lowercase card brand, e.g. visa. Absent when the method carries no brand.
​
string
Last four digits of the instrument. Absent when the method carries none.
​
string
required
The family the type belongs to.Available options: card, wallet, bank_debit, bank_transfer, voucher, redirect, crypto, balance, in_app_purchase, saved
​
string
required
Human-readable label for the method, e.g. Visa •••• 4242.
​
object
Present when the category is saved and the stored method is a card. Unlike the other previews this is the vault’s own record, not a claim from the collection surface. Absent for a balance, which has no instrument.

Properties

​
string
Lowercase card brand, e.g. visa. Absent when the method carries no brand.
​
string
Last four digits of the instrument. Absent when the method carries none.
​
string
required
The payment method type, e.g. card, apple_pay, klarna.
​
object
Present when the category is wallet. Carries the backing card’s brand and last four when the wallet surfaced them.

Properties

​
string
Lowercase card brand, e.g. visa. Absent when the method carries no brand.
​
string
Last four digits of the instrument. Absent when the method carries none.
​
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, expired
ConfirmationToken