Stripe: Confirmation tokens schemas

← Confirmation tokens operations · All schemas

Retrieve a Confirmation Token — response body

Field	Type	Presence	Description and constraints
$	object	Root	ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent. To learn more about how to use ConfirmationToken, visit the related guides: - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server) - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
mandate_data	JSON	Optional
mandate_data (anyOf 1)	JSON	Alternative	Data used for generating a Mandate.
mandate_data (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate
mandate_data (anyOf 2)	null	Alternative
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: confirmation_token
payment_intent	JSON	Optional
payment_intent (anyOf 1)	string	Alternative	ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. Maximum length: 5000
payment_intent (anyOf 2)	null	Alternative
payment_method_options	JSON	Optional
payment_method_options (anyOf 1)	JSON	Alternative	Payment-method-specific configuration for this ConfirmationToken.
payment_method_options (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration
payment_method_options (anyOf 2)	null	Alternative
payment_method_preview	JSON	Optional
payment_method_preview (anyOf 1)	JSON	Alternative	Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
payment_method_preview (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a ConfirmationToken — response body — payment_method_preview / value / allow_redisplay: always, limited, unspecified
payment_method_preview (anyOf 2)	null	Alternative
return_url	JSON	Optional
return_url (anyOf 1)	string	Alternative	Return URL used to confirm the Intent. Maximum length: 5000
return_url (anyOf 2)	null	Alternative
setup_future_usage	JSON	Optional
setup_future_usage (anyOf 1)	string	Alternative	Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. Known values: off_session, on_session
setup_future_usage (anyOf 2)	null	Alternative
setup_intent	JSON	Optional
setup_intent (anyOf 1)	string	Alternative	ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. Maximum length: 5000
setup_intent (anyOf 2)	null	Alternative
shipping	JSON	Optional
shipping (anyOf 1)	JSON	Alternative	Shipping information collected on this ConfirmationToken.
shipping (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Confirmation Token — response body — shipping value address, name, phone
shipping (anyOf 2)	null	Alternative
use_stripe_sdk	boolean	Required within parent	Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.

Referenced models: Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate, Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration, Retrieve a ConfirmationToken — response body — payment_method_preview / value / allow_redisplay: always, limited, unspecified, Retrieve a Confirmation Token — response body — shipping value address, name, phone

Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate

Field	Type	Presence	Description and constraints
$	object	Root	Data used for generating a Mandate.
customer_acceptance	Model	Required within parent	Expand Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance

Referenced models: Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance

Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance

Field	Type	Presence	Description and constraints
$	object	Root	This hash contains details about the customer acceptance of the Mandate.
online	JSON	Optional
online (anyOf 1)	JSON	Alternative	If this is a Mandate accepted online, this hash contains details about the online acceptance.
online (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance online value ip address, user agent
online (anyOf 2)	null	Alternative
type	string	Required within parent	The type of customer acceptance information included with the Mandate. Maximum length: 5000

Referenced models: Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance online value ip address, user agent

Retrieve a Confirmation Token — response body — mandate data Data used for generating a Mandate Data used for generating a Mandate customer acceptance online value ip address, user agent

Field	Type	Presence	Description and constraints
$	object	Root	This hash contains details about the online acceptance.
ip_address	JSON	Optional
ip_address (anyOf 1)	string	Alternative	The IP address from which the Mandate was accepted by the customer. Maximum length: 5000
ip_address (anyOf 2)	null	Alternative
user_agent	JSON	Optional
user_agent (anyOf 1)	string	Alternative	The user agent of the browser from which the Mandate was accepted by the customer. Maximum length: 5000
user_agent (anyOf 2)	null	Alternative

Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration

Field	Type	Presence	Description and constraints
$	object	Root	Payment-method-specific configuration
card	JSON	Optional
card (anyOf 1)	JSON	Alternative	This hash contains the card payment method options.
card (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options
card (anyOf 2)	null	Alternative

Referenced models: Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options

Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options

Field	Type	Presence	Description and constraints
$	object	Root	This hash contains the card payment method options.
cvc_token	JSON	Optional
cvc_token (anyOf 1)	string	Alternative	The `cvc_update` Token collected from the Payment Element. Maximum length: 5000
cvc_token (anyOf 2)	null	Alternative
installments	Model	Optional	Expand Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options installments

Referenced models: Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options installments

Retrieve a Confirmation Token — response body — payment method options value Payment-method-specific configuration card This hash contains the card payment method options This hash contains the card payment method options installments

Field	Type	Presence	Description and constraints
$	object	Root	Installment configuration for payments.
plan	Model	Optional	Expand Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits installments plan

Referenced models: Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits installments plan

Retrieve a Confirmation Token — response body — shipping value address, name, phone

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Location — response body — address
name	string	Required within parent	Recipient name. Maximum length: 5000
phone	JSON	Optional
phone (anyOf 1)	string	Alternative	Recipient phone (including extension). Maximum length: 5000
phone (anyOf 2)	null	Alternative

Referenced models: Create a Location — response body — address

Retrieve a ConfirmationToken — response body — payment_method_preview / value / allow_redisplay: always, limited, unspecified

Field	Type	Presence	Description and constraints
$	object	Root	Details of the PaymentMethod collected by Payment Element
acss_debit	Model	Optional	Expand Create a Payment Method — response body — acss debit
affirm	Model	Optional	Expand Create a Payment Method — response body — zip
afterpay_clearpay	Model	Optional	Expand Create a Payment Method — response body — zip
alipay	Model	Optional	Expand Create a Payment Method — response body — zip
allow_redisplay	string	Optional	This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. Known values: always, limited, unspecified
alma	Model	Optional	Expand Create a Payment Method — response body — zip
amazon_pay	Model	Optional	Expand Create a Payment Method — response body — zip
au_becs_debit	Model	Optional	Expand Create a Payment Method — response body — au becs debit
bacs_debit	Model	Optional	Expand Create a Payment Method — response body — bacs debit
bancontact	Model	Optional	Expand Create a Payment Method — response body — zip
billie	Model	Optional	Expand Create a Payment Method — response body — zip
billing_details	Model	Required within parent	Expand Create a charge — response body — billing details
bizum	Model	Optional	Expand Create a Payment Method — response body — bizum
blik	Model	Optional	Expand Create a Payment Method — response body — blik
boleto	Model	Optional	Expand Create a Payment Method — response body — boleto
card	Model	Optional	Expand Create a Payment Method — response body — card
card_present	Model	Optional	Expand Create a Payment Method — response body — card present
cashapp	Model	Optional	Expand Create a Payment Method — response body — cashapp
crypto	Model	Optional	Expand Create a Payment Method — response body — zip
customer	JSON	Optional
customer (anyOf 1)	JSON	Alternative	The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
customer (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer (anyOf 2)	null	Alternative
customer_account	JSON	Optional
customer_account (anyOf 1)	string	Alternative	Maximum length: 5000
customer_account (anyOf 2)	null	Alternative
customer_balance	Model	Optional	Expand Create a Payment Method — response body — zip
eps	Model	Optional	Expand Create a Payment Method — response body — eps
fpx	Model	Optional	Expand Create a Payment Method — response body — fpx
giropay	Model	Optional	Expand Create a Payment Method — response body — zip
grabpay	Model	Optional	Expand Create a Payment Method — response body — zip
ideal	Model	Optional	Expand Create a Payment Method — response body — ideal
interac_present	Model	Optional	Expand Create a Payment Method — response body — interac present
kakao_pay	Model	Optional	Expand Create a Payment Method — response body — zip
klarna	Model	Optional	Expand Create a Payment Method — response body — klarna
konbini	Model	Optional	Expand Create a Payment Method — response body — zip
kr_card	Model	Optional	Expand Create a Payment Method — response body — kr card
link	Model	Optional	Expand Create a Payment Method — response body — link
mb_way	Model	Optional	Expand Create a Payment Method — response body — zip
mobilepay	Model	Optional	Expand Create a Payment Method — response body — zip
multibanco	Model	Optional	Expand Create a Payment Method — response body — zip
naver_pay	Model	Optional	Expand Create a Payment Method — response body — naver pay
nz_bank_account	Model	Optional	Expand Create a Payment Method — response body — nz bank account
oxxo	Model	Optional	Expand Create a Payment Method — response body — zip
p24	Model	Optional	Expand Create a Payment Method — response body — p24
pay_by_bank	Model	Optional	Expand Create a Payment Method — response body — zip
payco	Model	Optional	Expand Create a Payment Method — response body — zip
paynow	Model	Optional	Expand Create a Payment Method — response body — zip
paypal	Model	Optional	Expand Create a Payment Method — response body — paypal
paypay	Model	Optional	Expand Create a Payment Method — response body — zip
payto	Model	Optional	Expand Create a Payment Method — response body — payto
pix	Model	Optional	Expand Create a Payment Method — response body — pix
promptpay	Model	Optional	Expand Create a Payment Method — response body — zip
revolut_pay	Model	Optional	Expand Create a Payment Method — response body — zip
samsung_pay	Model	Optional	Expand Create a Payment Method — response body — zip
satispay	Model	Optional	Expand Create a Payment Method — response body — zip
scalapay	Model	Optional	Expand Create a Payment Method — response body — zip
sepa_debit	Model	Optional	Expand Create a Payment Method — response body — sepa debit
sequra	Model	Optional	Expand Create a Payment Method — response body — zip
sofort	Model	Optional	Expand Create a Payment Method — response body — sofort
sunbit	Model	Optional	Expand Create a Payment Method — response body — zip
swish	Model	Optional	Expand Create a Payment Method — response body — zip
twint	Model	Optional	Expand Create a Payment Method — response body — zip
type	string	Required within parent	The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
upi	Model	Optional	Expand Create a Payment Method — response body — upi
us_bank_account	Model	Optional	Expand Create a Payment Method — response body — us bank account
wechat_pay	Model	Optional	Expand Create a Payment Method — response body — zip
zip	Model	Optional	Expand Create a Payment Method — response body — zip

Referenced models: Create a Payment Method — response body — zip, Create a charge — response body — billing details, Create a customer — response body, Create a Payment Method — response body — acss debit, Create a Payment Method — response body — au becs debit, Create a Payment Method — response body — bacs debit, Create a Payment Method — response body — bizum, Create a Payment Method — response body — blik, Create a Payment Method — response body — boleto, Create a Payment Method — response body — card, Create a Payment Method — response body — card present, Create a Payment Method — response body — cashapp, Create a Payment Method — response body — eps, Create a Payment Method — response body — fpx, Create a Payment Method — response body — ideal, Create a Payment Method — response body — interac present, Create a Payment Method — response body — klarna, Create a Payment Method — response body — kr card, Create a Payment Method — response body — link, Create a Payment Method — response body — naver pay, Create a Payment Method — response body — nz bank account, Create a Payment Method — response body — p24, Create a Payment Method — response body — paypal, Create a Payment Method — response body — payto, Create a Payment Method — response body — pix, Create a Payment Method — response body — sepa debit, Create a Payment Method — response body — sofort, Create a Payment Method — response body — upi, Create a Payment Method — response body — us bank account