SCPSetupIntentParameters

Objective-C


@interface SCPSetupIntentParameters : NSObject

Swift

class SetupIntentParameters : NSObject

Parameters for creating an SCPSetupIntent.

See

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

  • ID of the customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    Declaration

    Objective-C

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

    Swift

    var customer: String? { get }

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

    Declaration

    Objective-C

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

    Swift

    var stripeDescription: String? { get }

  • Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    See

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

    Declaration

    Objective-C

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

    Swift

    var metadata: [String : String]? { get }

  • Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to SCPSetupIntentUsageOffSession.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPSetupIntentUsage usage;

    Swift

    var usage: SetupIntentUsage { get }

  • Connect Only:** The Stripe account ID for which this SetupIntent is created.

    Declaration

    Objective-C

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

    Swift

    var onBehalfOf: String? { get }

  • The list of payment method types that this SetupIntent is allowed to use. The default is value for this is [SCPPaymentMethodTypeCardPresent].

    Declaration

    Objective-C

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

    Swift

    var paymentMethodTypes: [NSNumber] { get }

  • Unavailable

    Use SCPSetupIntentParametersBuilder

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPSetupIntentParametersBuilder

    Declaration

    Objective-C

    + (nonnull instancetype)new;

  • Deprecated

    Did you mean to use stripeDescription?

    Use stripeDescription for the string attached to the object.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;

    Swift

    var description: String { get }