SCPSetupAttempt

Objective-C


@interface SCPSetupAttempt : NSObject <SCPJSONDecodable>

Swift

class SetupAttempt : NSObject, JSONDecodable

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.

  • The ID of the Connect application that created the SetupIntent.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *application;

    Swift

    var application: String? { get }
  • Time at which the object was created.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull created;

    Swift

    var created: Date { get }
  • ID of the Customer this SetupIntent belongs to, if one exists.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *customer;

    Swift

    var customer: String? { get }
  • (Connect) The account (if any) for which the setup is intended.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *onBehalfOf;

    Swift

    var onBehalfOf: String? { get }
  • ID of the payment method used with this SetupAttempt.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *paymentMethod;

    Swift

    var paymentMethod: String? { get }
  • Details about the payment method at the time of SetupIntent confirmation.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPSetupAttemptPaymentMethodDetails *paymentMethodDetails;

    Swift

    var paymentMethodDetails: SCPSetupAttemptPaymentMethodDetails? { get }
  • ID of the SetupIntent that this attempt belongs to.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull setupIntent;

    Swift

    var setupIntent: String { get }
  • The status of this SetupAttempt. One of: requires_confirmation, requires_action, processing, succeeded, failed, or abandoned.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull status;

    Swift

    var status: String { get }
  • The unique identifier for the SetupAttempt.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull stripeId;

    Swift

    var stripeId: String { get }