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

    Interface StripeTerminalSdkType

    interface StripeTerminalSdkType {
        cancelCollectData(): Promise<{ error?: StripeError }>;
        cancelCollectInputs(): Promise<{ error?: StripeError }>;
        cancelCollectPaymentMethod(): Promise<{ error?: StripeError }>;
        cancelCollectRefundPaymentMethod(): Promise<{ error?: StripeError }>;
        cancelCollectSetupIntent(): Promise<{ error?: StripeError }>;
        cancelConfirmPaymentIntent(): Promise<{ error?: StripeError }>;
        cancelConfirmRefund(): Promise<{ error?: StripeError }>;
        cancelConfirmSetupIntent(): Promise<{ error?: StripeError }>;
        cancelDiscovering(): CancelDiscoveringResultType;
        cancelInstallingUpdate(): Promise<void>;
        cancelPaymentIntent(
            params: CancelPaymentMethodParams,
        ): Promise<PaymentIntentResultType>;
        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>;
        collectRefundPaymentMethod(
            params: RefundParams,
        ): Promise<CollectRefundPaymentMethodType>;
        collectSetupIntentPaymentMethod(
            params: CollectSetupIntentPaymentMethodParams,
        ): Promise<SetupIntentResultType>;
        confirmPaymentIntent(
            params: ConfirmPaymentMethodParams,
        ): Promise<PaymentIntentResultType>;
        confirmRefund(): Promise<ConfirmRefundResultType>;
        confirmSetupIntent(
            params: ConfirmSetupIntentMethodParams,
        ): Promise<SetupIntentResultType>;
        connectReader(
            params: ConnectReaderParams,
            discoveryMethod: Reader.DiscoveryMethod,
        ): Promise<ConnectReaderResultType>;
        createPaymentIntent(
            params: CreatePaymentIntentParams,
        ): Promise<PaymentIntentResultType>;
        createSetupIntent(
            params: CreateSetupIntentParams,
        ): Promise<SetupIntentResultType>;
        disconnectReader(): Promise<DisconnectReaderResultType>;
        discoverReaders(params: DiscoverReadersParams): DiscoverReadersResultType;
        getConnectedReader(): Promise<Reader.Type>;
        getConnectionStatus(): Promise<ConnectionStatus>;
        getLocations(params: GetLocationsParams): Promise<GetLocationsResultType>;
        getNativeSdkVersion(): Promise<string>;
        getOfflineStatus(): Promise<OfflineStatus>;
        getPaymentStatus(): Promise<PaymentStatus>;
        getReaderSettings(): Promise<ReaderSettings>;
        initialize(params: InternalInitParams): InitializeResultNativeType;
        installAvailableUpdate(): Promise<void>;
        print(content: string): Promise<{ error?: StripeError }>;
        rebootReader(): Promise<RebootReaderResultType>;
        retrievePaymentIntent(
            clientSecret: string,
        ): Promise<PaymentIntentResultType>;
        retrieveSetupIntent(clientSecret: string): Promise<SetupIntentResultType>;
        setConnectionToken(params: SetConnectionTokenParams): Promise<void>;
        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 }>;
        simulateReaderUpdate(update: SimulateUpdateType): Promise<void>;
        supportsReadersOfType(
            params: ReaderSupportParams,
        ): Promise<ReaderSupportResult>;
    }
    Index

    Methods

    cancelCollectData cancelCollectInputs cancelCollectPaymentMethod cancelCollectRefundPaymentMethod cancelCollectSetupIntent cancelConfirmPaymentIntent cancelConfirmRefund cancelConfirmSetupIntent cancelDiscovering cancelInstallingUpdate cancelPaymentIntent cancelReaderReconnection cancelSetupIntent clearCachedCredentials clearReaderDisplay collectData collectInputs collectPaymentMethod collectRefundPaymentMethod collectSetupIntentPaymentMethod confirmPaymentIntent confirmRefund confirmSetupIntent connectReader createPaymentIntent createSetupIntent disconnectReader discoverReaders getConnectedReader getConnectionStatus getLocations getNativeSdkVersion getOfflineStatus getPaymentStatus getReaderSettings initialize installAvailableUpdate print rebootReader retrievePaymentIntent retrieveSetupIntent setConnectionToken setReaderDisplay setReaderSettings setSimulatedCard setSimulatedCollectInputsResult setSimulatedOfflineMode setTapToPayUxConfiguration simulateReaderUpdate supportsReadersOfType

    Methods

    • Parameters

      • params: InternalInitParams

      Returns InitializeResultNativeType

    • Prints the specified content to the connected reader's printer, if available.

      Parameters

      • content: string

        The content to print. Must be an image (JPEG/PNG) encoded as a base64 string or 'data:' URI scheme.

      Returns Promise<{ error?: StripeError }>

      A promise that resolves to an empty object if the print succeeds, or an object containing a StripeError if the print fails.

    • Parameters

      • simulatedCollectInputsBehavior: string

      Returns Promise<{ error?: StripeError }>

    Settings

    Member Visibility

    On This Page

    Methods
    cancelCollectDatacancelCollectInputscancelCollectPaymentMethodcancelCollectRefundPaymentMethodcancelCollectSetupIntentcancelConfirmPaymentIntentcancelConfirmRefundcancelConfirmSetupIntentcancelDiscoveringcancelInstallingUpdatecancelPaymentIntentcancelReaderReconnectioncancelSetupIntentclearCachedCredentialsclearReaderDisplaycollectDatacollectInputscollectPaymentMethodcollectRefundPaymentMethodcollectSetupIntentPaymentMethodconfirmPaymentIntentconfirmRefundconfirmSetupIntentconnectReadercreatePaymentIntentcreateSetupIntentdisconnectReaderdiscoverReadersgetConnectedReadergetConnectionStatusgetLocationsgetNativeSdkVersiongetOfflineStatusgetPaymentStatusgetReaderSettingsinitializeinstallAvailableUpdateprintrebootReaderretrievePaymentIntentretrieveSetupIntentsetConnectionTokensetReaderDisplaysetReaderSettingssetSimulatedCardsetSimulatedCollectInputsResultsetSimulatedOfflineModesetTapToPayUxConfigurationsimulateReaderUpdatesupportsReadersOfType