payments-core/com.stripe.android.model/ConfirmationToken

ConfirmationToken

Confirmation Token objects help transport client-side data collected by Elements to your server for payment confirmation. They capture payment method information, shipping details, and other checkout state from Elements, then pass them to your server where you can use them to confirm a PaymentIntent or SetupIntent.

Confirmation Tokens are single-use and expire 15 minutes after creation.

Think of the ConfirmationToken as an immutable bag of data that serves two purposes:

Transport checkout state collected by Elements needed to confirm an Intent
Capture Elements configuration for validation at confirmation time

Related guides: Confirmation Tokens

Types

PaymentMethodPreview

class PaymentMethodPreview : StripeModel

Preview of the payment method data collected from Elements. This represents the transactional checkout state, not a reusable PaymentMethod object.

Properties

created

@JvmField

val created: Long

Time at which the object was created. Measured in seconds since the Unix epoch.

expiresAt

@JvmField

val expiresAt: Long?

Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.

@JvmField

val id: String

Unique identifier for the object.

liveMode

@JvmField

val liveMode: Boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

paymentIntentId

@JvmField

val paymentIntentId: String?

ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

paymentMethodPreview

@JvmField

val paymentMethodPreview: ConfirmationToken.PaymentMethodPreview?

Payment method data collected from Elements. This represents the transactional checkout state, not a reusable PaymentMethod object.

returnUrl

@JvmField

val returnUrl: String?

Return URL used to confirm the intent for redirect-based methods.

setupFutureUsage

@JvmField

val setupFutureUsage: ConfirmPaymentIntentParams.SetupFutureUsage?

Indicates how you intend to use the payment method for future payments. This is automatically determined based on Elements configuration and user input.

setupIntentId

@JvmField

val setupIntentId: String?

ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

shipping

@JvmField

val shipping: ShippingInformation?

Shipping information collected on this ConfirmationToken.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)