SCPSetupIntent

Objective-C


@interface SCPSetupIntent : NSObject <SCPJSONDecodable, NSCopying>

Swift

class SetupIntent : NSObject, JSONDecodable, NSCopying

A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

  • The unique identifier for the intent.

    Declaration

    Objective-C

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

    Swift

    var stripeId: String { get }
  • When the intent was created.

    Declaration

    Objective-C

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

    Swift

    var created: Date { get }
  • The identifier of a customer object to which the SetupIntent is attached, if applicable.

    Declaration

    Objective-C

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

    Swift

    var customer: String? { get }
  • Set of key-value pairs attached to the object.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDictionary *metadata;

    Swift

    var metadata: [AnyHashable : Any]? { get }
  • An SCPSetupIntentUsage value describing how the SetupIntent will be used. Defaults to off-session if not set.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPSetupIntentUsage usage;

    Swift

    var usage: SetupIntentUsage { get }
  • The status of the intent.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPSetupIntentStatus status;

    Swift

    var status: SetupIntentStatus { get }
  • The most recent SetupAttempt for this SetupIntent

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPSetupAttempt *latestAttempt;

    Swift

    var latestAttempt: SCPSetupAttempt? { get }
  • Unavailable

    You cannot directly instantiate this class. You should only use SetupIntents that have been returned by other methods in our SDK.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Unavailable

    You cannot directly instantiate this class. You should only use SetupIntents that have been returned by other methods in our SDK.

    Declaration

    Objective-C

    + (nonnull instancetype)new;