SCPConnectionConfiguration

Objective-C


@interface SCPConnectionConfiguration : NSObject

Swift

class ConnectionConfiguration : NSObject

This class lets you set options that define reader behavior throughout a given reader-to-SDK connection session. Currently, the options are only applicable to the Verifone P400.

  • If set to true, the connection will automatically error if the reader is already connected to a device and collecting payment. When set to false, this will allow you to connect to a reader already connected to another device, and will break the existing reader-to-SDK connection on the other device when it attempts to collect payment.

    Note that this parameter is only applicable for the Verifone P400.

    If Terminal.connectReader is invoked without a SCPConnectionConfiguration, then failIfInUse defaults to NO.

    See

    https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL failIfInUse;

    Swift

    var failIfInUse: Bool { get }

  • If set to true, the customer will be able to press the red X button on the Verifone P400 to cancel a collectPaymentMethod, collectReusableCard, or collectRefundPaymentMethod command.

    The property defaults to NO if not set.

    This behavior is part of a private beta. Setting it will have no effect if you are not part of the allowCustomerCancel beta program.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL allowCustomerCancel;

    Swift

    var allowCustomerCancel: Bool { get }

  • Initialize your connect options with all possible properties.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse
                        allowCustomerCancel:(BOOL)allowCustomerCancel;

    Swift

    init(failIfInUse: Bool, allowCustomerCancel: Bool)

  • Initalize your connect options with fail if in use.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse;

    Swift

    init(failIfInUse: Bool)

  • Initialize your connect options with allowCustomerCancel.

    This property is in private beta, and will have no effect if you are not part of the allowCustomerCancel beta program.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAllowCustomerCancel:(BOOL)allowCustomerCancel;

    Swift

    init(allowCustomerCancel: Bool)