@stripe/stripe-terminal-react-native
    Preparing search index...

    Interface WithStripeTerminalProps

    Public SDK functions and state returned by useStripeTerminal and injected by withStripeTerminal. Use inside StripeTerminalProvider.

    interface WithStripeTerminalProps {
        cancelCollectData: () => Promise<{ error?: StripeError }>;
        cancelCollectInputs: () => Promise<{ error?: StripeError }>;
        cancelCollectPaymentMethod: () => Promise<{ error?: StripeError }>;
        cancelCollectSetupIntent: () => Promise<{ error?: StripeError }>;
        cancelConfirmPaymentIntent: () => Promise<{ error?: StripeError }>;
        cancelConfirmSetupIntent: () => Promise<{ error?: StripeError }>;
        cancelDiscovering: () => Promise<CancelDiscoveringResultType>;
        cancelEasyConnect: () => Promise<CancelDiscoveringResultType>;
        cancelInstallingUpdate: () => Promise<{ error?: StripeError }>;
        cancelPaymentIntent: (
            params: CancelPaymentMethodParams,
        ) => Promise<PaymentIntentResultType>;
        cancelProcessPaymentIntent: () => Promise<{ error?: StripeError }>;
        cancelProcessRefund: () => Promise<{ error?: StripeError }>;
        cancelProcessSetupIntent: () => Promise<{ error?: StripeError }>;
        cancelReaderReconnection: () => Promise<{ error?: StripeError }>;
        cancelSetupIntent: (
            params: CancelSetupIntentMethodParams,
        ) => Promise<SetupIntentResultType>;
        clearCachedCredentials: () => Promise<{ error?: StripeError }>;
        clearReaderDisplay: () => Promise<ClearReaderDisplayResultType>;
        collectData: (params: CollectDataParams) => Promise<CollectDataResultType>;
        collectInputs: (
            params: ICollectInputsParameters,
        ) => Promise<ICollectInputsResults>;
        collectPaymentMethod: (
            params: CollectPaymentMethodParams,
        ) => Promise<PaymentIntentResultType>;
        collectSetupIntentPaymentMethod: (
            params: CollectSetupIntentPaymentMethodParams,
        ) => Promise<SetupIntentResultType>;
        confirmPaymentIntent: (
            param: ConfirmPaymentMethodParams,
        ) => Promise<PaymentIntentResultType>;
        confirmSetupIntent: (
            params: ConfirmSetupIntentMethodParams,
        ) => Promise<SetupIntentResultType>;
        connectedReader: Reader.Type | null | undefined;
        connectReader: (
            params: ConnectReaderParams,
        ) => Promise<ConnectReaderResultType>;
        createPaymentIntent: (
            params: CreatePaymentIntentParams,
        ) => Promise<PaymentIntentResultType>;
        createSetupIntent: (
            params: CreateSetupIntentParams,
        ) => Promise<SetupIntentResultType>;
        disconnectReader: () => Promise<DisconnectReaderResultType | undefined>;
        discoveredReaders: Reader.Type[];
        discoverReaders: (
            params: DiscoverReadersParams,
        ) => Promise<DiscoverReadersResultType>;
        easyConnect: (
            params: EasyConnectParams,
        ) => Promise<ConnectReaderResultType>;
        emitter: EventEmitter | undefined;
        getConnectedReader: () => Promise<GetConnectedReaderType>;
        getConnectionStatus: () => Promise<ConnectionStatus>;
        getIsInitialized: () => boolean;
        getLocations: (
            params: GetLocationsParams,
        ) => Promise<GetLocationsResultType>;
        getNativeSdkVersion: () => Promise<string>;
        getOfflineStatus: () => Promise<OfflineStatus>;
        getPaymentStatus: () => Promise<PaymentStatus>;
        getReaderSettings: () => Promise<ReaderSettings>;
        initialize: () => Promise<InitializeResultType>;
        installAvailableUpdate: () => Promise<{ error?: StripeError }>;
        isInitialized: boolean;
        loading: boolean;
        print: (content: string) => Promise<{ error?: StripeError }>;
        processPaymentIntent: (
            param: ProcessPaymentIntentParams,
        ) => Promise<PaymentIntentResultType>;
        processRefund: (params: RefundParams) => Promise<ProcessRefundResultType>;
        processSetupIntent: (
            params: ProcessSetupIntentParams,
        ) => Promise<SetupIntentResultType>;
        rebootReader: () => Promise<RebootReaderResultType | undefined>;
        retrievePaymentIntent: (
            clientSecret: string,
        ) => Promise<PaymentIntentResultType>;
        retrieveSetupIntent: (
            clientSecret: string,
        ) => Promise<SetupIntentResultType>;
        setReaderDisplay: (cart: Cart) => Promise<{ error?: StripeError }>;
        setReaderSettings: (
            params: ReaderSettingsParameters,
        ) => Promise<ReaderSettings>;
        setSimulatedCard: (cardNumber: string) => Promise<{ error?: StripeError }>;
        setSimulatedCollectInputsResult: (
            simulatedCollectInputsBehavior: string,
        ) => Promise<{ error?: StripeError }>;
        setSimulatedOfflineMode: (
            simulatedOffline: boolean,
        ) => Promise<{ error?: StripeError }>;
        setTapToPayUxConfiguration: (
            params: TapToPayUxConfiguration,
        ) => Promise<{ error?: StripeError }>;
        supportsReadersOfType: (
            params: ReaderSupportParams,
        ) => Promise<ReaderSupportResult>;
    }
    Index

    Properties

    cancelCollectData cancelCollectInputs cancelCollectPaymentMethod cancelCollectSetupIntent cancelConfirmPaymentIntent cancelConfirmSetupIntent cancelDiscovering cancelEasyConnect cancelInstallingUpdate cancelPaymentIntent cancelProcessPaymentIntent cancelProcessRefund cancelProcessSetupIntent cancelReaderReconnection cancelSetupIntent clearCachedCredentials clearReaderDisplay collectData collectInputs collectPaymentMethod collectSetupIntentPaymentMethod confirmPaymentIntent confirmSetupIntent connectedReader connectReader createPaymentIntent createSetupIntent disconnectReader discoveredReaders discoverReaders easyConnect emitter getConnectedReader getConnectionStatus getIsInitialized getLocations getNativeSdkVersion getOfflineStatus getPaymentStatus getReaderSettings initialize installAvailableUpdate isInitialized loading print processPaymentIntent processRefund processSetupIntent rebootReader retrievePaymentIntent retrieveSetupIntent setReaderDisplay setReaderSettings setSimulatedCard setSimulatedCollectInputsResult setSimulatedOfflineMode setTapToPayUxConfiguration supportsReadersOfType

    Properties

    cancelCollectData: () => Promise<{ error?: StripeError }> = _cancelCollectData
    cancelCollectInputs: () => Promise<{ error?: StripeError }> = _cancelCollectInputs
    cancelCollectPaymentMethod: () => Promise<{ error?: StripeError }> = _cancelCollectPaymentMethod
    cancelCollectSetupIntent: () => Promise<{ error?: StripeError }> = _cancelCollectSetupIntent
    cancelConfirmPaymentIntent: () => Promise<{ error?: StripeError }> = _cancelConfirmPaymentIntent
    cancelConfirmSetupIntent: () => Promise<{ error?: StripeError }> = _cancelConfirmSetupIntent
    cancelDiscovering: () => Promise<CancelDiscoveringResultType> = _cancelDiscovering
    cancelEasyConnect: () => Promise<CancelDiscoveringResultType> = _cancelEasyConnect
    cancelInstallingUpdate: () => Promise<{ error?: StripeError }> = _cancelInstallingUpdate
    cancelPaymentIntent: (
        params: CancelPaymentMethodParams,
    ) => Promise<PaymentIntentResultType> = _cancelPaymentIntent
    cancelProcessPaymentIntent: () => Promise<{ error?: StripeError }> = _cancelProcessPaymentIntent
    cancelProcessRefund: () => Promise<{ error?: StripeError }> = _cancelProcessRefund
    cancelProcessSetupIntent: () => Promise<{ error?: StripeError }> = cancelProcessSetupIntent
    cancelReaderReconnection: () => Promise<{ error?: StripeError }> = _cancelReaderReconnection
    cancelSetupIntent: (
        params: CancelSetupIntentMethodParams,
    ) => Promise<SetupIntentResultType> = _cancelSetupIntent
    clearCachedCredentials: () => Promise<{ error?: StripeError }> = _clearCachedCredentials
    clearReaderDisplay: () => Promise<ClearReaderDisplayResultType> = _clearReaderDisplay
    collectData: (params: CollectDataParams) => Promise<CollectDataResultType> = _collectData
    collectInputs: (
        params: ICollectInputsParameters,
    ) => Promise<ICollectInputsResults> = _collectInputs
    collectPaymentMethod: (
        params: CollectPaymentMethodParams,
    ) => Promise<PaymentIntentResultType> = _collectPaymentMethod
    collectSetupIntentPaymentMethod: (
        params: CollectSetupIntentPaymentMethodParams,
    ) => Promise<SetupIntentResultType> = _collectSetupIntentPaymentMethod
    confirmPaymentIntent: (
        param: ConfirmPaymentMethodParams,
    ) => Promise<PaymentIntentResultType> = _confirmPaymentIntent
    confirmSetupIntent: (
        params: ConfirmSetupIntentMethodParams,
    ) => Promise<SetupIntentResultType> = _confirmSetupIntent
    connectedReader: Reader.Type | null | undefined
    connectReader: (params: ConnectReaderParams) => Promise<ConnectReaderResultType> = _connectReader
    createPaymentIntent: (
        params: CreatePaymentIntentParams,
    ) => Promise<PaymentIntentResultType> = _createPaymentIntent
    createSetupIntent: (
        params: CreateSetupIntentParams,
    ) => Promise<SetupIntentResultType> = _createSetupIntent
    disconnectReader: () => Promise<DisconnectReaderResultType | undefined> = _disconnectReader
    discoveredReaders: Reader.Type[]
    discoverReaders: (
        params: DiscoverReadersParams,
    ) => Promise<DiscoverReadersResultType> = _discoverReaders
    easyConnect: (params: EasyConnectParams) => Promise<ConnectReaderResultType> = _easyConnect
    emitter: EventEmitter | undefined = emitter
    getConnectedReader: () => Promise<GetConnectedReaderType> = _getConnectedReader
    getConnectionStatus: () => Promise<ConnectionStatus> = _getConnectionStatus
    getIsInitialized: () => boolean
    getLocations: (params: GetLocationsParams) => Promise<GetLocationsResultType> = _getLocations
    getNativeSdkVersion: () => Promise<string> = _getNativeSdkVersion
    getOfflineStatus: () => Promise<OfflineStatus> = _getOfflineStatus
    getPaymentStatus: () => Promise<PaymentStatus> = _getPaymentStatus
    getReaderSettings: () => Promise<ReaderSettings> = _getReaderSettings
    initialize: () => Promise<InitializeResultType> = _initialize
    installAvailableUpdate: () => Promise<{ error?: StripeError }> = _installAvailableUpdate
    isInitialized: boolean
    loading: boolean
    print: (content: string) => Promise<{ error?: StripeError }> = _print
    processPaymentIntent: (
        param: ProcessPaymentIntentParams,
    ) => Promise<PaymentIntentResultType> = _processPaymentIntent
    processRefund: (params: RefundParams) => Promise<ProcessRefundResultType> = _processRefund
    processSetupIntent: (
        params: ProcessSetupIntentParams,
    ) => Promise<SetupIntentResultType> = _processSetupIntent
    rebootReader: () => Promise<RebootReaderResultType | undefined> = _rebootReader
    retrievePaymentIntent: (
        clientSecret: string,
    ) => Promise<PaymentIntentResultType> = _retrievePaymentIntent
    retrieveSetupIntent: (clientSecret: string) => Promise<SetupIntentResultType> = _retrieveSetupIntent
    setReaderDisplay: (cart: Cart) => Promise<{ error?: StripeError }> = _setReaderDisplay
    setReaderSettings: (params: ReaderSettingsParameters) => Promise<ReaderSettings> = _setReaderSettings
    setSimulatedCard: (cardNumber: string) => Promise<{ error?: StripeError }> = _setSimulatedCard
    setSimulatedCollectInputsResult: (
        simulatedCollectInputsBehavior: string,
    ) => Promise<{ error?: StripeError }> = _setSimulatedCollectInputsResult
    setSimulatedOfflineMode: (
        simulatedOffline: boolean,
    ) => Promise<{ error?: StripeError }> = _setSimulatedOfflineMode
    setTapToPayUxConfiguration: (
        params: TapToPayUxConfiguration,
    ) => Promise<{ error?: StripeError }> = _setTapToPayUxConfiguration
    supportsReadersOfType: (
        params: ReaderSupportParams,
    ) => Promise<ReaderSupportResult> = _supportsReadersOfType

    Settings

    Member Visibility

    On This Page

    Properties
    cancelCollectDatacancelCollectInputscancelCollectPaymentMethodcancelCollectSetupIntentcancelConfirmPaymentIntentcancelConfirmSetupIntentcancelDiscoveringcancelEasyConnectcancelInstallingUpdatecancelPaymentIntentcancelProcessPaymentIntentcancelProcessRefundcancelProcessSetupIntentcancelReaderReconnectioncancelSetupIntentclearCachedCredentialsclearReaderDisplaycollectDatacollectInputscollectPaymentMethodcollectSetupIntentPaymentMethodconfirmPaymentIntentconfirmSetupIntentconnectedReaderconnectReadercreatePaymentIntentcreateSetupIntentdisconnectReaderdiscoveredReadersdiscoverReaderseasyConnectemittergetConnectedReadergetConnectionStatusgetIsInitializedgetLocationsgetNativeSdkVersiongetOfflineStatusgetPaymentStatusgetReaderSettingsinitializeinstallAvailableUpdateisInitializedloadingprintprocessPaymentIntentprocessRefundprocessSetupIntentrebootReaderretrievePaymentIntentretrieveSetupIntentsetReaderDisplaysetReaderSettingssetSimulatedCardsetSimulatedCollectInputsResultsetSimulatedOfflineModesetTapToPayUxConfigurationsupportsReadersOfType