external/com.stripe.stripeterminal.external.models/SetupIntent

SetupIntent

@JsonClass(generateAdapter = true)

data class SetupIntent : Parcelable

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

See the API Reference for SetupIntents for more information.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

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

Properties

applicationId

val applicationId: String?

ID of the Connect application that created the SetupIntent.

cancellationReason

val cancellationReason: SetupIntentCancellationReason?

Reason for cancellation of this SetupIntent.

clientSecret

val clientSecret: String?

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

created

val created: Long = 0

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

customerId

val customerId: String?

ID of the Customer this SetupIntent belongs to, if one exists.

description

val description: String?

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

val id: String

Unique identifier for the object.

isLiveMode

val isLiveMode: Boolean = false

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

lastSetupError

val lastSetupError: ApiError?

The error encountered in the previous SetupIntent confirmation.

latestAttempt

val latestAttempt: SetupAttempt?

The most recent SetupAttempt for this SetupIntent, expanded as an object.

latestAttemptId

val latestAttemptId: String?

The ID if the most recent SetupAttempt for this SetupIntent.

mandateId

val mandateId: String?

ID of the multi use Mandate generated by the SetupIntent.

metadata

val metadata: Map<String, String>

Set of key-value pairs that you can attach to an object.

nextAction

val nextAction: SetupIntentNextAction?

onBehalfOfId

val onBehalfOfId: String?

The account (if any) for which the setup is intended.

paymentMethodData

@Transient

var paymentMethodData: PaymentMethodData? = null

paymentMethodId

val paymentMethodId: String?

ID of the payment method used with this SetupIntent.

paymentMethodOptions

val paymentMethodOptions: PaymentMethodOptions?

Payment-method-specific configuration for this SetupIntent.

paymentMethodTypes

val paymentMethodTypes: List<String>

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

singleUseMandateId

val singleUseMandateId: String?

ID of the single_use Mandate generated by the SetupIntent.

status

val status: SetupIntentStatus?

Status of this SetupIntent.

usage

val usage: SetupIntentUsage?

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