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

SetupIntent

data class SetupIntent @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(val id: String?, val cancellationReason: SetupIntent.CancellationReason?, val created: Long, val countryCode: String?, val clientSecret: String?, val description: String?, val isLiveMode: Boolean, val paymentMethod: PaymentMethod? = null, val paymentMethodId: String?, val paymentMethodTypes: List<String>, val status: StripeIntent.Status?, val usage: StripeIntent.Usage?, val lastSetupError: SetupIntent.Error? = null, val unactivatedPaymentMethods: List<String>, val linkFundingSources: List<String>, val nextActionData: StripeIntent.NextActionData?, paymentMethodOptionsJsonString: String? = null) : StripeIntent

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

Constructors

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

constructor(id: String?, cancellationReason: SetupIntent.CancellationReason?, created: Long, countryCode: String?, clientSecret: String?, description: String?, isLiveMode: Boolean, paymentMethod: PaymentMethod? = null, paymentMethodId: String?, paymentMethodTypes: List<String>, status: StripeIntent.Status?, usage: StripeIntent.Usage?, lastSetupError: SetupIntent.Error? = null, unactivatedPaymentMethods: List<String>, linkFundingSources: List<String>, nextActionData: StripeIntent.NextActionData?, paymentMethodOptionsJsonString: String? = null)

Types

CancellationReason

enum CancellationReason : Enum<SetupIntent.CancellationReason>

Reason for cancellation of a SetupIntent.

object Companion

data class Error : StripeModel

The error encountered in the previous SetupIntent confirmation.

Properties

cancellationReason

val cancellationReason: SetupIntent.CancellationReason?

Reason for cancellation of this SetupIntent.

open override val clientSecret: String?

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

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open override val countryCode: String?

Country code of the user.

open override val created: Long

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

open override val description: String?

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

open override val id: String?

Unique identifier for the object.

open override val isConfirmed: Boolean

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

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.

lastErrorMessage

open override val lastErrorMessage: String?

val lastSetupError: SetupIntent.Error? = null

The error encountered in the previous SetupIntent confirmation.

linkFundingSources

open override val linkFundingSources: List<String>

Payment types that are accepted when paying with Link.

open override val nextActionData: StripeIntent.NextActionData?

open override val nextActionType: StripeIntent.NextActionType?

open override val paymentMethod: PaymentMethod? = null

The expanded PaymentMethod represented by paymentMethodId.

paymentMethodId

open override val paymentMethodId: String?

ID of the payment method used with this SetupIntent.

paymentMethodTypes

open override val paymentMethodTypes: List<String>

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

open override val status: StripeIntent.Status?

Status of this SetupIntent.

unactivatedPaymentMethods

open override val unactivatedPaymentMethods: List<String>

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

val usage: StripeIntent.Usage?

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

Functions

describeContents

abstract fun describeContents(): Int

getPaymentMethodOptions

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open override fun getPaymentMethodOptions(): Map<String, Any?>

fun StripeIntent.getRequestCode(): Int

open override fun requiresAction(): Boolean

requiresConfirmation

open override fun requiresConfirmation(): Boolean

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