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

SetupIntent

@Serializable

data class SetupIntent : Serializable

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.

Properties

@SerialName(value = "application")

val applicationId: String?

ID of the Connect application that created the SetupIntent.

cancellationReason

val cancellationReason: SetupIntentCancellationReason?

Reason for cancellation of this SetupIntent.

val clientSecret: String?

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

val created: Long = 0

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

@SerialName(value = "customer")

val customerId: String?

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

val description: String?

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

val id: String?

Unique identifier for the object.

@SerialName(value = "livemode")

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.

val lastSetupError: ApiError?

The error encountered in the previous SetupIntent confirmation.

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.

@SerialName(value = "mandate")

val mandateId: String?

ID of the multi use Mandate generated by the SetupIntent.

val metadata: Map<String, String>

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

val nextAction: SetupIntentNextAction?

@Transient

var offlineDetails: SetupIntentOfflineDetails?

The offlineDetails for this intent, if created or processed while offline. When created offline the id will be nil. The OfflineDetails.requiresUpload can be used to identify that the intent was processed offline and requires the device to be brought back online before the intent can be captured. See Also: How to operate offline

@SerialName(value = "onBehalfOf")

val onBehalfOfId: String?

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

paymentMethodId

@SerialName(value = "paymentMethod")

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

@SerialName(value = "singleUseMandate")

val singleUseMandateId: String?

ID of the single_use Mandate generated by the SetupIntent.

var status: SetupIntentStatus?

Status of this SetupIntent.

val usage: SetupIntentUsage?

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