Cancel auto-reconnection
Cancels an in-progress collectInputs.
Cancels an in-progress collectRefundPaymentMethod.
Cancels an in-progress collectSetupIntentPaymentMethod.
Cancels the active PaymentIntent.
Cancels the active SetupIntent.
Collects raw card data (magstripe or NFC UID) from the connected reader without creating a payment.
Displays forms on the connected reader and collects the customer's input.
Only supported on Internet-connected smart readers (for example the BBPOS WisePOS E and Stripe Reader S700).
OptionalcollectConfig: CollectConfigCollects a payment method for an in-person refund.
Follow this with confirmRefund to complete the refund. Interac refunds must be processed in person.
Collects a payment method for the active SetupIntent.
Call createSetupIntent or retrieveSetupIntent first.
Optionalparams: CollectSetupIntentPaymentMethodParamsConfirms the refund for the payment method collected by collectRefundPaymentMethod.
Confirms the active SetupIntent, saving the collected card for future use.
Attempts to connect to an AppsOnDevices reader (Android only).
Optional_config: AppsOnDevicesConnectionConfigurationReader
Attempts to connect to the given bluetooth reader.
Reader
Attempts to connect to the given internet reader.
Optionalconfig: InternetConnectionConfigurationReader
Attempts to connect to the local device's NFC reader.
Reader
Attempts to connect to the given reader via usb.
Reader
Creates a new PaymentIntent on the device.
This requires a connected reader and is only available for readers that support creating payment intents on device. Most integrations should create the PaymentIntent on their backend and use retrievePaymentIntent instead.
Creates a new SetupIntent on the device, used to save a card for future payments.
Removes all event listeners and resets the plugin instance to an uninitialized state. Call this when the plugin is no longer needed (e.g. on component unmount) to prevent listener leaks.
The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.
In your implementation of this method, you should notify your user that the reader has disconnected.
Requires autoReconnectOnUnexpectedDisconnect is set to true in the BluetoothConnectionConfiguration
The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.
In your implementation of this method, you should notify your user that the reader disconnected and that reconnection attempts are being made.
Requires autoReconnectOnUnexpectedDisconnect is set to true in the BluetoothConnectionConfiguration
The SDK was able to reconnect to the previously connected Bluetooth reader.
In your implementation of this method, you should notify your user that reader connection has been re-established.
Requires autoReconnectOnUnexpectedDisconnect is set to true in the BluetoothConnectionConfiguration
Subscribe to battery updates reported by the connected reader.
Bluetooth and Tap to Pay readers only.
OptionalerrorCallback: (error: Error) => voidRetrieves the settings currently reported by the connected reader.
Optionaloptions: ListLocationsParametersReboots the connected reader.
The reader will disconnect while it restarts.
Retrieves a SetupIntent created on your backend and makes it the active setup intent.
Updates the settings on the connected reader and returns the resulting settings.
Returns whether the current mobile device supports the given reader type using the given discovery method.
The type of reader to check support for.
The discovery method to check support for.
Whether to check for simulated reader support.
StaticcheckStaticcreateCreates an instance of [[StripeTerminalPlugin]] with the given options.
const terminal = await StripeTerminalPlugin.create({
fetchConnectionToken: async () => {
const resp = await fetch('https://your-backend.dev/token', {
method: 'POST'
})
const data = await resp.json()
return data.secret
},
onUnexpectedReaderDisconnect: () => {
// handle reader disconnect
}
})
[[StripeTerminalPlugin]] options.
StaticgetStaticrequest
This should not be used directly. It will not behave correctly when using
InternetandBothdiscovery methods