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
Link copied to clipboard
abstract fun describeContents(): Int
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

applicationId
Link copied to clipboard
val applicationId: String?
ID of the Connect application that created the SetupIntent.
cancellationReason
Link copied to clipboard
val cancellationReason: SetupIntentCancellationReason?
Reason for cancellation of this SetupIntent.
clientSecret
Link copied to clipboard
val clientSecret: String?
The client secret of this SetupIntent.
created
Link copied to clipboard
val created: Long = 0L
Time at which the object was created.
customerId
Link copied to clipboard
val customerId: String?
ID of the Customer this SetupIntent belongs to, if one exists.
description
Link copied to clipboard
val description: String?
An arbitrary string attached to the object.
id
Link copied to clipboard
val id: String
Unique identifier for the object.
isLiveMode
Link copied to clipboard
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
Link copied to clipboard
val lastSetupError: ApiError?
The error encountered in the previous SetupIntent confirmation.
latestAttempt
Link copied to clipboard
val latestAttempt: SetupAttempt?
The most recent SetupAttempt for this SetupIntent, expanded as an object.
latestAttemptId
Link copied to clipboard
val latestAttemptId: String?
The ID if the most recent SetupAttempt for this SetupIntent.
mandateId
Link copied to clipboard
val mandateId: String?
ID of the multi use Mandate generated by the SetupIntent.
metadata
Link copied to clipboard
val metadata: Map<String, String>
Set of key-value pairs that you can attach to an object.
nextAction
Link copied to clipboard
val nextAction: SetupIntentNextAction?
onBehalfOfId
Link copied to clipboard
val onBehalfOfId: String?
The account (if any) for which the setup is intended.
paymentMethodData
Link copied to clipboard
var paymentMethodData: PaymentMethodData? = null
paymentMethodId
Link copied to clipboard
val paymentMethodId: String?
ID of the payment method used with this SetupIntent.
paymentMethodOptions
Link copied to clipboard
val paymentMethodOptions: PaymentMethodOptions?
Payment-method-specific configuration for this SetupIntent.
paymentMethodTypes
Link copied to clipboard
val paymentMethodTypes: List<String>
The list of payment method types (e.g.
singleUseMandateId
Link copied to clipboard
val singleUseMandateId: String?
ID of the single_use Mandate generated by the SetupIntent.
status
Link copied to clipboard
val status: SetupIntentStatus?
usage
Link copied to clipboard
val usage: SetupIntentUsage?
Indicates how the payment method is intended to be used in the future.