Interface StripeTerminalSdkType

Hierarchy

StripeTerminalSdkType

Index

Methods

Methods

cancelCollectInputs

cancelCollectInputs(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:165
Returns Promise<{ error?: StripeError<CommonError> }>

cancelCollectPaymentMethod

cancelCollectPaymentMethod(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:145
Returns Promise<{ error?: StripeError<CommonError> }>

cancelCollectRefundPaymentMethod

cancelCollectRefundPaymentMethod(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:138
Returns Promise<{ error?: StripeError<CommonError> }>

cancelCollectSetupIntent

cancelCollectSetupIntent(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:148
Returns Promise<{ error?: StripeError<CommonError> }>

cancelDiscovering

cancelDiscovering(): CancelDiscoveringResultType

- Defined in StripeTerminalSdk.tsx:64
Returns CancelDiscoveringResultType

cancelInstallingUpdate

cancelInstallingUpdate(): Promise<void>

- Defined in StripeTerminalSdk.tsx:116
Returns Promise<void>

cancelPaymentIntent

cancelPaymentIntent(params: CancelPaymentMethodParams): Promise<PaymentIntentResultType>

- Defined in StripeTerminalSdk.tsx:106
Parameters
- params: CancelPaymentMethodParams
Returns Promise<PaymentIntentResultType>

cancelReaderReconnection

cancelReaderReconnection(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:169
Returns Promise<{ error?: StripeError<CommonError> }>

cancelSetupIntent

cancelSetupIntent(params: CancelSetupIntentMethodParams): Promise<SetupIntentResultType>

- Defined in StripeTerminalSdk.tsx:125
Parameters
- params: CancelSetupIntentMethodParams
Returns Promise<SetupIntentResultType>

clearCachedCredentials

clearCachedCredentials(): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:142
Returns Promise<{ error?: StripeError<CommonError> }>

clearReaderDisplay

clearReaderDisplay(): Promise<ClearReaderDisplayResultType>

- Defined in StripeTerminalSdk.tsx:122
Returns Promise<ClearReaderDisplayResultType>

collectData

collectData(params: CollectDataParams): Promise<CollectDataResultType>

- Defined in StripeTerminalSdk.tsx:168
Parameters
- params: CollectDataParams
Returns Promise<CollectDataResultType>

collectInputs

collectInputs(params: ICollectInputsParameters): Promise<ICollectInputsResults>

- Defined in StripeTerminalSdk.tsx:162
Parameters
- params: ICollectInputsParameters
Returns Promise<ICollectInputsResults>

collectPaymentMethod

collectPaymentMethod(params: CollectPaymentMethodParams): Promise<PaymentIntentResultType>

- Defined in StripeTerminalSdk.tsx:92
Parameters
- params: CollectPaymentMethodParams
Returns Promise<PaymentIntentResultType>

collectRefundPaymentMethod

collectRefundPaymentMethod(params: RefundParams): Promise<CollectRefundPaymentMethodType>

- Defined in StripeTerminalSdk.tsx:135
Parameters
- params: RefundParams
Returns Promise<CollectRefundPaymentMethodType>

collectSetupIntentPaymentMethod

collectSetupIntentPaymentMethod(params: CollectSetupIntentPaymentMethodParams): Promise<SetupIntentResultType>

- Defined in StripeTerminalSdk.tsx:110
Parameters
- params: CollectSetupIntentPaymentMethodParams
Returns Promise<SetupIntentResultType>

confirmPaymentIntent

confirmPaymentIntent(params: ConfirmPaymentMethodParams): Promise<PaymentIntentResultType>

- Defined in StripeTerminalSdk.tsx:98
Parameters
- params: ConfirmPaymentMethodParams
Returns Promise<PaymentIntentResultType>

confirmRefund

confirmRefund(): Promise<ConfirmRefundResultType>

- Defined in StripeTerminalSdk.tsx:141
Returns Promise<ConfirmRefundResultType>

confirmSetupIntent

confirmSetupIntent(params: ConfirmSetupIntentMethodParams): Promise<SetupIntentResultType>

- Defined in StripeTerminalSdk.tsx:131
Parameters
- params: ConfirmSetupIntentMethodParams
Returns Promise<SetupIntentResultType>

connectBluetoothReader

connectBluetoothReader(params: ConnectBluetoothReaderParams): Promise<ConnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:66
Parameters
- params: ConnectBluetoothReaderParams
Returns Promise<ConnectReaderResultType>

connectHandoffReader

connectHandoffReader(params: ConnectHandoffParams): Promise<ConnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:73
Parameters
- params: ConnectHandoffParams
Returns Promise<ConnectReaderResultType>

connectInternetReader

connectInternetReader(params: ConnectInternetReaderParams): Promise<ConnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:70
Parameters
- params: ConnectInternetReaderParams
Returns Promise<ConnectReaderResultType>

connectLocalMobileReader

connectLocalMobileReader(params: ConnectLocalMobileParams): Promise<ConnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:76
Parameters
- params: ConnectLocalMobileParams
Returns Promise<ConnectReaderResultType>

connectUsbReader

connectUsbReader(params: ConnectUsbReaderParams): Promise<ConnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:80
Parameters
- params: ConnectUsbReaderParams
Returns Promise<ConnectReaderResultType>

createPaymentIntent

createPaymentIntent(params: CreatePaymentIntentParams): Promise<PaymentIntentResultType>

- Defined in StripeTerminalSdk.tsx:88
Parameters
- params: CreatePaymentIntentParams
Returns Promise<PaymentIntentResultType>

createSetupIntent

createSetupIntent(params: CreateSetupIntentParams): Promise<SetupIntentResultType>

- Defined in StripeTerminalSdk.tsx:102
Parameters
- params: CreateSetupIntentParams
Returns Promise<SetupIntentResultType>

disconnectReader

disconnectReader(): Promise<DisconnectReaderResultType>

- Defined in StripeTerminalSdk.tsx:84
Returns Promise<DisconnectReaderResultType>

discoverReaders

discoverReaders(params: DiscoverReadersParams): DiscoverReadersResultType

- Defined in StripeTerminalSdk.tsx:62
Parameters
- params: DiscoverReadersParams
Returns DiscoverReadersResultType

getConnectedReader

getConnectedReader(): Promise<Reader.Type>

- Defined in StripeTerminalSdk.tsx:157
Returns Promise<Reader.Type>

getConnectionStatus

getConnectionStatus(): Promise<ConnectionStatus>

- Defined in StripeTerminalSdk.tsx:156
Returns Promise<ConnectionStatus>

getLocations

getLocations(params: GetLocationsParams): Promise<GetLocationsResultType>

- Defined in StripeTerminalSdk.tsx:129
Parameters
- params: GetLocationsParams
Returns Promise<GetLocationsResultType>

getNativeSdkVersion

getNativeSdkVersion(): Promise<string>

- Defined in StripeTerminalSdk.tsx:178
Returns Promise<string>

getOfflineStatus

getOfflineStatus(): Promise<OfflineStatus>

- Defined in StripeTerminalSdk.tsx:154
Returns Promise<OfflineStatus>

getPaymentStatus

getPaymentStatus(): Promise<PaymentStatus>

- Defined in StripeTerminalSdk.tsx:155
Returns Promise<PaymentStatus>

getReaderSettings

getReaderSettings(): Promise<ReaderSettings>

- Defined in StripeTerminalSdk.tsx:158
Returns Promise<ReaderSettings>

initialize

initialize(params: InternalInitParams): InitializeResultNativeType

- Defined in StripeTerminalSdk.tsx:58
Parameters
- params: InternalInitParams
Returns InitializeResultNativeType

installAvailableUpdate

installAvailableUpdate(): Promise<void>

- Defined in StripeTerminalSdk.tsx:114
Returns Promise<void>

rebootReader

rebootReader(): Promise<RebootReaderResultType>

- Defined in StripeTerminalSdk.tsx:86
Returns Promise<RebootReaderResultType>

retrievePaymentIntent

retrievePaymentIntent(clientSecret: string): Promise<PaymentIntentResultType>

- Defined in StripeTerminalSdk.tsx:96
Parameters
- clientSecret: string
Returns Promise<PaymentIntentResultType>

retrieveSetupIntent

retrieveSetupIntent(clientSecret: string): Promise<SetupIntentResultType>

- Defined in StripeTerminalSdk.tsx:123
Parameters
- clientSecret: string
Returns Promise<SetupIntentResultType>

setConnectionToken

setConnectionToken(params: SetConnectionTokenParams): Promise<void>

- Defined in StripeTerminalSdk.tsx:60
Parameters
- params: SetConnectionTokenParams
Returns Promise<void>

setLocalMobileUxConfiguration

setLocalMobileUxConfiguration(params: LocalMobileUxConfiguration): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:175
Parameters
- params: LocalMobileUxConfiguration
Returns Promise<{ error?: StripeError<CommonError> }>

setReaderDisplay

setReaderDisplay(cart: Cart): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:118
Parameters
- cart: Cart
Returns Promise<{ error?: StripeError<CommonError> }>

setReaderSettings

setReaderSettings(params: ReaderSettingsParameters): Promise<ReaderSettings>

- Defined in StripeTerminalSdk.tsx:159
Parameters
- params: ReaderSettingsParameters
Returns Promise<ReaderSettings>

setSimulatedCard

setSimulatedCard(cardNumber: string): Promise<{ error?: StripeError<CommonError> }>

- Defined in StripeTerminalSdk.tsx:151
Parameters
- cardNumber: string
Returns Promise<{ error?: StripeError<CommonError> }>

simulateReaderUpdate

simulateReaderUpdate(update: SimulateUpdateType): Promise<void>

- Defined in StripeTerminalSdk.tsx:134
Parameters
- update: SimulateUpdateType
Returns Promise<void>

supportsReadersOfType

supportsReadersOfType(params: ReaderSupportParams): Promise<ReaderSupportResult>

- Defined in StripeTerminalSdk.tsx:172
Parameters
- params: ReaderSupportParams
Returns Promise<ReaderSupportResult>

Generated using TypeDoc