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, readonly) BOOL skipTipping;

    Swift

    var skipTipping: Bool { get }

  • 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, readonly, nullable) SCPTippingConfiguration *tippingConfiguration;

    Swift

    var tippingConfiguration: SCPTippingConfiguration? { get }

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

    Attempting to collect with updatePaymentIntent enabled and a PaymentIntent created while offline will error with SCPErrorUpdatePaymentIntentUnavailableWhileOffline.

    Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL updatePaymentIntent;

    Swift

    var updatePaymentIntent: Bool { get }

  • Whether to show a cancel button in transaction UI on Stripe smart readers.

    Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL enableCustomerCancellation;

    Swift

    var enableCustomerCancellation: Bool { get }

  • Request Dynamic Currency Conversion for the presented payment method if available.

    updatePaymentIntent must be set to true for dynamic currency conversion to be enabled.

    Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL requestDynamicCurrencyConversion;

    Swift

    var requestDynamicCurrencyConversion: Bool { get }

  • Display a notice on the reader collection screen to inform cardholders about surcharging on a transaction

    updatePaymentIntent must be set to true for to display a surcharge notice

    Defaults to nil.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *surchargeNotice;

    Swift

    var surchargeNotice: String? { get }

  • Obtain customer consent to save payment method details and set this field to reflect accordingly whether this payment method can be shown again to its customer in a checkout flow.

    allowRedisplay must be set to always or limited if setup_future_usage is used

    Defaults to SCPAllowRedisplayUnspecified

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPAllowRedisplay allowRedisplay;

    Swift

    var allowRedisplay: AllowRedisplay { get }

  • Collect and process the payment as a Mail Order/Telephone Order payment on Stripe smart readers. Contact Stripe support to enable this feature on your account.

    See

    https://docs.stripe.com/terminal/features/mail-telephone-orders/overview

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isMoto) BOOL moto;

    Swift

    var isMoto: Bool { get }

  • Unavailable

    Use SCPCollectConfigurationBuilder.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPCollectConfigurationBuilder.

    Declaration

    Objective-C

    + (nonnull instancetype)new;