Function useStripeTerminal
useStripeTerminal( props?: UserCallbacks,): { 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: () => Promise<{ error?: StripeError<CommonError> }>; cancelInstallingUpdate: () => Promise<{ error?: StripeError }>; 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<{ error?: StripeError }>; collectSetupIntentPaymentMethod: ( params: CollectSetupIntentPaymentMethodParams, ) => Promise<SetupIntentResultType>; confirmPaymentIntent: ( param: ConfirmPaymentMethodParams, ) => Promise<PaymentIntentResultType>; confirmRefund: () => Promise<ConfirmRefundResultType>; confirmSetupIntent: ( params: ConfirmSetupIntentMethodParams, ) => Promise<SetupIntentResultType>; connectedReader: undefined | null | Reader.Type; connectReader: ( params: ConnectReaderParams, discoveryMethod: Reader.DiscoveryMethod, ) => Promise<ConnectReaderResultType>; createPaymentIntent: ( params: CreatePaymentIntentParams, ) => Promise<PaymentIntentResultType>; createSetupIntent: ( params: CreateSetupIntentParams, ) => Promise<SetupIntentResultType>; disconnectReader: () => Promise<undefined | DisconnectReaderResultType>; discoveredReaders: Reader.Type[]; discoverReaders: ( params: DiscoverReadersParams, ) => Promise<{ error?: StripeError<CommonError> }>; emitter: undefined | EventEmitter; 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: () => Promise< | { error?: undefined; reader?: Reader.Type } | { error: StripeError; reader?: undefined } | { error: { code: string; message: string }; reader: undefined }, >; installAvailableUpdate: () => Promise<{ error?: StripeError }>; isInitialized: boolean; loading: boolean; rebootReader: () => Promise<undefined | RebootReaderResultType>; 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 }>; setTapToPayUxConfiguration: ( params: TapToPayUxConfiguration, ) => Promise<{ error?: StripeError }>; simulateReaderUpdate: ( update: SimulateUpdateType, ) => Promise<{ error?: StripeError }>; supportsReadersOfType: ( params: ReaderSupportParams, ) => Promise<ReaderSupportResult>;} Returns {
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: () => Promise<{ error?: StripeError<CommonError> }>;
cancelInstallingUpdate: () => Promise<{ error?: StripeError }>;
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<{ error?: StripeError }>;
collectSetupIntentPaymentMethod: (
params: CollectSetupIntentPaymentMethodParams,
) => Promise<SetupIntentResultType>;
confirmPaymentIntent: (
param: ConfirmPaymentMethodParams,
) => Promise<PaymentIntentResultType>;
confirmRefund: () => Promise<ConfirmRefundResultType>;
confirmSetupIntent: (
params: ConfirmSetupIntentMethodParams,
) => Promise<SetupIntentResultType>;
connectedReader: undefined | null | Reader.Type;
connectReader: (
params: ConnectReaderParams,
discoveryMethod: Reader.DiscoveryMethod,
) => Promise<ConnectReaderResultType>;
createPaymentIntent: (
params: CreatePaymentIntentParams,
) => Promise<PaymentIntentResultType>;
createSetupIntent: (
params: CreateSetupIntentParams,
) => Promise<SetupIntentResultType>;
disconnectReader: () => Promise<undefined | DisconnectReaderResultType>;
discoveredReaders: Reader.Type[];
discoverReaders: (
params: DiscoverReadersParams,
) => Promise<{ error?: StripeError<CommonError> }>;
emitter: undefined | EventEmitter;
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: () => Promise<
| { error?: undefined; reader?: Reader.Type }
| { error: StripeError; reader?: undefined }
| { error: { code: string; message: string }; reader: undefined },
>;
installAvailableUpdate: () => Promise<{ error?: StripeError }>;
isInitialized: boolean;
loading: boolean;
rebootReader: () => Promise<undefined | RebootReaderResultType>;
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 }>;
setTapToPayUxConfiguration: (
params: TapToPayUxConfiguration,
) => Promise<{ error?: StripeError }>;
simulateReaderUpdate: (
update: SimulateUpdateType,
) => Promise<{ error?: StripeError }>;
supportsReadersOfType: (
params: ReaderSupportParams,
) => Promise<ReaderSupportResult>;
}
useStripeTerminal hook. This hook gives you an acesss to all available SDK methods as well as the state of the current connection