SCPCollectConfiguration

Objective-C


@interface SCPCollectConfiguration : NSObject <NSCopying>

Swift

class CollectConfiguration : NSObject, NSCopying

The CollectConfiguration contains configuration information relevant to collecting a payment method.

  • Bypass tipping selection if it would have otherwise been shown.

    Defaults to NO.

    See

    https://stripe.com/docs/terminal/features/collecting-tips/on-reader

    Declaration

    Objective-C

    @property (nonatomic) BOOL skipTipping;

    Swift

    var skipTipping: Bool { get set }

  • The tipping configuration for this payment collection.

    See

    https://stripe.com/docs/terminal/features/collecting-tips/on-reader#tip-eligible

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SCPTippingConfiguration *tippingConfiguration;

    Swift

    var tippingConfiguration: SCPTippingConfiguration? { get set }

  • Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL updatePaymentIntent;

    Swift

    var updatePaymentIntent: Bool { get set }

  • Initialize a CollectConfiguration

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping;

    Swift

    convenience init(skipTipping: Bool)

    Parameters

    skipTipping

    Bypass tipping selection if it would have otherwise been shown.

  • Initialize a CollectConfiguration

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent;

    Swift

    convenience init(updatePaymentIntent: Bool)

    Parameters

    updatePaymentIntent

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

  • Initialize a CollectConfiguration.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTippingConfiguration:
    (nonnull SCPTippingConfiguration *)tippingConfiguration;

    Swift

    convenience init(tippingConfiguration: SCPTippingConfiguration)

    Parameters

    tippingConfiguration

    Tipping configuration for the payment method collection.

  • Initialize a CollectConfiguration

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
                        updatePaymentIntent:(BOOL)updatePaymentIntent;

    Swift

    convenience init(skipTipping: Bool, updatePaymentIntent: Bool)

    Parameters

    skipTipping

    Bypass tipping selection if it would have otherwise been shown.
    updatePaymentIntent

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

  • Initialize a CollectConfiguration.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
                       tippingConfiguration:(nullable SCPTippingConfiguration *)
                                                tippingConfiguration;

    Swift

    convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)

    Parameters

    skipTipping

    Bypass tipping selection if it would have otherwise been shown.
    tippingConfiguration

    Tipping configuration for the payment method collection.

  • Initialize a CollectConfiguration.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent
                               tippingConfiguration:
                                   (nullable SCPTippingConfiguration *)
                                       tippingConfiguration;

    Swift

    convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)

    Parameters

    updatePaymentIntent

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.
    tippingConfiguration

    Tipping configuration for the payment method collection.

  • Initialize a CollectConfiguration.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
                        updatePaymentIntent:(BOOL)updatePaymentIntent
                       tippingConfiguration:(nullable SCPTippingConfiguration *)
                                                tippingConfiguration;

    Swift

    init(skipTipping: Bool, updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)

    Parameters

    skipTipping

    Bypass tipping selection if it would have otherwise been shown.
    updatePaymentIntent

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.
    tippingConfiguration

    Tipping configuration for the payment method collection.

  • Unavailable

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    Declaration

    Objective-C

    + (nonnull instancetype)new;