SCPCollectSetupIntentConfiguration

Objective-C


@interface SCPCollectSetupIntentConfiguration : NSObject <NSCopying>

Swift

class CollectSetupIntentConfiguration : NSObject, NSCopying

The CollectSetupIntentConfiguration contains configuration information relevant to collecting a payment method for an SCPSetupIntent.

  • Controls whether the payment method may be shown again to its customer in a checkout flow.

    Card networks require that you collect consent from the customer before saving and reusing their card information. The SetupIntent confirmation API method normally takes a mandate_data hash that lets you specify details about the customer’s consent. The Stripe Terminal SDK will fill in the mandate_data hash with relevant information, but in order for it to do so, you must specify whether you have gathered consent from the cardholder using this property.

    The payment method will not be collected without the cardholder’s consent.

    allowRedisplay must be set to always or limited.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPAllowRedisplay allowRedisplay;

    Swift

    var allowRedisplay: AllowRedisplay { get }

  • Controls whether customer-initiated cancellation is enabled during setup intent collection.

    Defaults to SCPCustomerCancellationEnableIfAvailable.

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPCustomerCancellation customerCancellation;

    Swift

    var customerCancellation: CustomerCancellation { get }

  • Collect and process the SetupIntent 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, strong, readonly, nullable) SCPMotoConfiguration *motoConfiguration;

    Swift

    var motoConfiguration: MotoConfiguration? { get }

  • The collection reason, applicable only for Tap to Pay devices.

    Defaults to SCPSetupIntentCollectionReasonSaveCard

    Declaration

    Objective-C

    @property (nonatomic, readonly) SCPSetupIntentCollectionReason collectionReason;

    Swift

    var collectionReason: SetupIntentCollectionReason { get }

  • Unavailable

    Use SCPCollectSetupIntentConfigurationBuilder.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPCollectSetupIntentConfigurationBuilder.

    Declaration

    Objective-C

    + (nonnull instancetype)new;