capacitor-stripe-terminal
    Preparing search index...

    Interface TapToPayConnectionConfiguration

    interface TapToPayConnectionConfiguration {
        locationId: string;
        merchantDisplayName?: string;
        onBehalfOf?: string;
        tosAcceptancePermitted?: boolean;
    }

    Hierarchy (View Summary)

    Index
    locationId: string

    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 will not be changed.

    When connecting to a simulated reader, pass in the reader's pre-existing mock location. You can find the mock location ID on the reader object, on the locationId property.

    merchantDisplayName?: string

    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.

    onBehalfOf?: string

    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 TapToPayConnectionConfiguration. 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.

    tosAcceptancePermitted?: boolean

    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 successfully, 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.
    false