SetupAttempt

@Serializable
data class SetupAttempt : Serializable

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful.

You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

See the API Reference for SetupIntents for more information.

Properties

Link copied to clipboard
@SerialName(value = "application")
val applicationId: String?

The value of application on the SetupIntent at the time of this confirmation.

Link copied to clipboard

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

Link copied to clipboard
@SerialName(value = "customer")
val customerId: String?

The value of customer on the SetupIntent at the time of this confirmation.

Link copied to clipboard
val id: String

Unique identifier for the object.

Link copied to clipboard
@SerialName(value = "livemode")
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
@SerialName(value = "onBehalfOf")
val onBehalfOfId: String?

The value of on_behalf_of on the SetupIntent at the time of this confirmation.

Link copied to clipboard

Details about the payment method at the time of SetupIntent confirmation.

Link copied to clipboard
@SerialName(value = "paymentMethod")
val paymentMethodId: String?

ID of the payment method used with this SetupAttempt.

Link copied to clipboard

The error encountered during this attempt to confirm the SetupIntent, if any.

Link copied to clipboard
@SerialName(value = "setupIntent")
val setupIntentId: String?

ID of the SetupIntent that this attempt belongs to.

Link copied to clipboard

Status of this SetupAttempt.

Link copied to clipboard

The value of usage on the SetupIntent at the time of this confirmation.