SCPLocalMobileConnectionConfiguration

Objective-C


@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration

Swift

class LocalMobileConnectionConfiguration : ConnectionConfiguration

This class lets you set options that define local mobile reader behavior throughout a given reader-to-SDK connection session.

  • The ID of the Location which the reader should be registered to during connection. If the provided ID matches the location the reader is already registered to, the location field on the reader object will not be changed.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull locationId;

    Swift

    var locationId: String { get }

  • If your integration is creating destination charges and using on_behalf_of, you must provide the connected_account_id in the onBehalfOf parameter as part of the SCPLocalMobileConnectionConfiguration. Unlike other reader types which require this information on a per-transaction basis, the Apple Built-In reader requires this on a per-connection basis as well in order to establish a reader connection.

    See

    https://stripe.com/docs/terminal/features/connect#destination-payment-intents

    Declaration

    Objective-C

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

    Swift

    var onBehalfOf: String? { get }

  • Optional cardholder facing merchant display name that will be used in the prompt for the cardholder to present their card. If this value is not provided, the merchant display name will be taken from the Terminal Location.display_name associated with the connection.

    Declaration

    Objective-C

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

    Swift

    var merchantDisplayName: String? { get }

  • In order to connect to a reader, merchant-specific terms of service may need to be accepted. Presenting the flow requires iCloud sign-in and an authorized individual. This attribute determines how the connection process should proceed if this situation is encountered.

    • If YES, the terms the terms of service should be presented during connection. If accepted successfully, the connection process will resume. If not accepted succesfully, the connection will fail with an error.

    • If NO, the terms of service will not be presented and the connection will fail with an error.

    See

    SCPErrorAppleBuiltInReaderTOSNotYetAccepted

    Note

    Defaults to YES when not otherwise specified.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isTOSAcceptancePermitted) BOOL tosAcceptancePermitted;

    Swift

    var isTOSAcceptancePermitted: Bool { get }

  • In iOS 16.4 and later, the local mobile reader can return the card read results as soon as they are available instead of waiting for the system UI to dismiss completely. This flow can substantially reduce the amount of time it takes for a transaction to complete.

    Note

    Defaults to YES when not otherwise specified.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isReturnReadResultImmediatelyEnabled)
    BOOL returnReadResultImmediatelyEnabled;

    Swift

    var isReturnReadResultImmediatelyEnabled: Bool { get }

  • When set to true, the Terminal SDK will attempt a local mobile auto-reconnection on any unexpected disconnect. You must also set an autoReconnectionDelegate for your application to respond accordingly to reconnection attempts. Enabling autoReconnectOnUnexpectedDisconnect without providing an autoReconnectionDelegate will error with SCPErrorReaderConnectionConfigurationInvalid.

    When set to false, we will immediately surface any disconnection through TerminalDelegate.

    Defaults to false.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isAutoReconnectOnUnexpectedDisconnect)
    BOOL autoReconnectOnUnexpectedDisconnect;

    Swift

    var isAutoReconnectOnUnexpectedDisconnect: Bool { get }

  • Contains callback methods for local mobile auto-reconnection.

    Declaration

    Objective-C

    @property (nonatomic, weak, readonly, nullable) id<SCPReconnectionDelegate> autoReconnectionDelegate;

    Swift

    weak var autoReconnectionDelegate: ReconnectionDelegate? { get }

  • Unavailable

    Use SCPLocalMobileConnectionConfigurationBuilder

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Use SCPLocalMobileConnectionConfigurationBuilder

    Declaration

    Objective-C

    + (nonnull instancetype)new;