SCPSetupIntent

Objective-C


@interface SCPSetupIntent : NSObject <NSCopying>

Swift

class SetupIntent : NSObject, 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.

See

https://stripe.com/docs/api/setup_intents

  • The unique identifier for the intent.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *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.

    See

    https://stripe.com/docs/api#metadata

    Declaration

    Objective-C

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

    Swift

    var metadata: [String : String]? { 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 }

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

    Declaration

    Objective-C

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

    Swift

    var stripeDescription: String? { get }

  • If present, this property tells you what actions you need to take for your customer to continue payment setup.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPNextAction *nextAction;

    Swift

    var nextAction: SCPNextAction? { get }

  • ID of the payment method used with this SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var paymentMethod: String? { get }

  • Whether this SetupIntent was created in live mode or test mode.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL livemode;

    Swift

    var livemode: Bool { get }

  • ID of the multi use Mandate generated by the SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var mandate: String? { get }

  • ID of the single_use Mandate generated by the SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var singleUseMandate: String? { get }

  • ID of the Connect application that created the SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var application: String? { get }

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

    Declaration

    Objective-C

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

    Swift

    var onBehalfOf: String? { get }

  • Payment-method-specific configuration for this SetupIntent.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SCPPaymentMethodOptionsParameters *paymentMethodOptions;

    Swift

    var paymentMethodOptions: SCPPaymentMethodOptionsParameters? { get }

  • Reason for cancellation of this SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var cancellationReason: String? { get }

  • The list of payment method types that this SetupIntent is allowed to use. These are NSNumber’s where the value is in SCPPaymentMethodType.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSNumber *> *_Nonnull paymentMethodTypes;

    Swift

    var paymentMethodTypes: [NSNumber] { get }

  • The client secret for this intent.

    Declaration

    Objective-C

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

    Swift

    var clientSecret: String? { 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;