SetupIntent

data class SetupIntent : StripeIntent

A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.

Types

Link copied to clipboard
enum CancellationReason : Enum<SetupIntent.CancellationReason>

Reason for cancellation of a SetupIntent.

Link copied to clipboard
object Companion
Link copied to clipboard
data class Error : StripeModel

The error encountered in the previous SetupIntent confirmation.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open override fun requiresAction(): Boolean
Link copied to clipboard
open override fun requiresConfirmation(): Boolean
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val cancellationReason: SetupIntent.CancellationReason?

Reason for cancellation of this SetupIntent.

Link copied to clipboard
open override val clientSecret: String?

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

Link copied to clipboard
open override val created: Long

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

Link copied to clipboard
open override val description: String?

An arbitrary string attached to the object. Often useful for displaying to users.

Link copied to clipboard
open override val id: String?

Unique identifier for the object.

Link copied to clipboard
open override val isConfirmed: Boolean

Whether confirmation has succeeded and all required actions have been handled.

Link copied to clipboard
open override val isLiveMode: Boolean

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

Link copied to clipboard
open override val lastErrorMessage: String?
Link copied to clipboard
val lastSetupError: SetupIntent.Error? = null

The error encountered in the previous SetupIntent confirmation.

Link copied to clipboard
open override val nextActionData: StripeIntent.NextActionData?
Link copied to clipboard
open override val nextActionType: StripeIntent.NextActionType?
Link copied to clipboard
open override val paymentMethod: PaymentMethod? = null

The expanded PaymentMethod represented by paymentMethodId.

Link copied to clipboard
open override val paymentMethodId: String?

ID of the payment method used with this SetupIntent.

Link copied to clipboard
open override val paymentMethodTypes: List<String>

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

Link copied to clipboard
open override val status: StripeIntent.Status?
Link copied to clipboard
open override val unactivatedPaymentMethods: List<String>

Payment types that have not been activated in livemode, but have been activated in testmode.

Link copied to clipboard
val usage: StripeIntent.Usage?

Indicates how the payment method is intended to be used in the future.