API

method initialize(...)

Initializes the Stripe Terminal SDK and its connection-token provider.
Call this once before discovering readers.

When tokenProviderEndpoint is provided, the plugin sends a POST request
and expects { secret: string }. When it is omitted, handle
RequestedConnectionToken and call setConnectionToken() instead.

initialize(options: StripeTerminalInitializationOptions) => Promise<void>

method discoverReaders(...)

Discovers readers using the requested transport. The returned readers are
snapshots; listen for DiscoveredReaders when continuous discovery can
produce additional results.

discoverReaders(options: DiscoverReadersOptions) => Promise<{ readers: ReaderInterface[]; }>

method setConnectionToken(...)

Supplies a connection-token secret after RequestedConnectionToken is
emitted. Create each token on your server and use it only once.

setConnectionToken(options: SetConnectionTokenOptions) => Promise<void>

method setSimulatorConfiguration(...)

Configures the simulated reader used in test mode. Call before the
operation whose behavior you want to simulate.

Stripe docs reference

setSimulatorConfiguration(options: SimulatorConfigurationOptions) => Promise<void>

method connectReader(...)

Connects to a reader returned by discoverReaders().

connectReader(options: ConnectReaderOptions) => Promise<void>

method getConnectedReader()

Returns the currently connected reader, or null when disconnected.

getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>

method disconnectReader()

Disconnects the active reader. Resolves immediately if none is connected.

disconnectReader() => Promise<void>

method cancelDiscoverReaders()

Cancels the active reader-discovery operation.

cancelDiscoverReaders() => Promise<void>

method collectPaymentMethod(...)

Collects a payment method for a server-created PaymentIntent. Confirm the
collected intent with confirmPaymentIntent().

collectPaymentMethod(options: CollectPaymentMethodOptions) => Promise<void>

method cancelCollectPaymentMethod()

Cancels an in-progress collectPaymentMethod() call.

cancelCollectPaymentMethod() => Promise<void>

method confirmPaymentIntent()

Confirms the PaymentIntent most recently collected by the reader.

confirmPaymentIntent() => Promise<void>

method installAvailableUpdate()

Installs the software update reported by ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

method cancelInstallUpdate()

Cancels an in-progress optional reader software update.

cancelInstallUpdate() => Promise<void>

method setReaderDisplay(...)

Displays cart details on a reader with a customer-facing display.

setReaderDisplay(options: Cart) => Promise<void>

method clearReaderDisplay()

Clears cart details from the reader's customer-facing display.

clearReaderDisplay() => Promise<void>

method rebootReader()

Reboots the connected reader. Supported reader types are platform dependent.

rebootReader() => Promise<void>

method cancelReaderReconnection()

Cancels an automatic reader reconnection attempt.

cancelReaderReconnection() => Promise<void>

method setTapToPayUxConfiguration(...)

Configure the Tap to Pay UX appearance (Android only).
Call this after initialize() but before connectReader().
Has no effect on iOS or web platforms.

setTapToPayUxConfiguration(options: TapToPayUxConfiguration) => Promise<void>

method isTapToPayAccountLinked(...)

Check whether the merchant has accepted Apple's Tap to Pay on iPhone
Terms and Conditions.

iOS only, and requires iOS 16.4 or later. initialize() must have been
called first because the SDK needs a connection token provider, but no
reader connection is required and the call does not activate the device.

The answer is read from Apple on every call. Apple's Tap to Pay on iPhone
requirements state that acceptance state must be retrieved from Apple
rather than from a local variable, so do not cache the result.

Stripe docs reference

isTapToPayAccountLinked(options?: IsTapToPayAccountLinkedOptions | undefined) => Promise<{ isLinked: boolean; }>

method addListener(TerminalEventsEnum.Loaded, ...)

Emitted after the Terminal SDK has initialized.

addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Emitted when the SDK needs a connection token and no token endpoint was
configured. Respond by calling setConnectionToken().

addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Emitted whenever discovery produces an updated reader list. During iOS
Bluetooth discovery this event can be emitted multiple times.

https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetoothhttps://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetooth

addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ConnectedReader, ...)

Emitted after a reader connects successfully.

addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Emitted when the reader is disconnected, either in response to disconnectReader()
or some connection error.

For all reader types, this is emitted in response to disconnectReader()
without a reason property.

For Bluetooth and USB readers, this is emitted with a reason property when the reader disconnects.

Note: For Bluetooth and USB readers, when you call disconnectReader(), this event
will be emitted twice: one without a reason in acknowledgement of your call, and again with a reason when the reader
finishes disconnecting.

addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Emitted when the Terminal's connection status changed.

Note: You should not use this method to detect when a reader unexpectedly disconnects from your app,
as it cannot be used to accurately distinguish between expected and unexpected disconnect events.

To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
the UnexpectedReaderDisconnect event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

The Terminal disconnected unexpectedly from the reader.

In your implementation of this method, you may want to notify your user that the reader disconnected.
You may also call discoverReaders() to begin scanning for readers, and attempt
to automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
possible to cancel calls to discoverReaders()

When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
implementing the DisconnectedReader event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Emitted after confirmPaymentIntent() succeeds.

addListener(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Emitted after collectPaymentMethod() succeeds.

addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.Canceled, ...)

Emitted when cancelCollectPaymentMethod() is called and succeeds.
The Promise returned by cancelCollectPaymentMethod() will also be resolved.

addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.Failed, ...)

Emitted when either collectPaymentMethod() or confirmPaymentIntent()
fails. The Promise returned by the relevant call will also be rejected.

addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: (info: { message: string; code?: string; declineCode?: string; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Emitted when a software update is available for the connected reader.

addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the connected reader begins installing a software update.
If a mandatory software update is available when a reader first connects, that update is
automatically installed. The update will be installed before ConnectedReader is emitted and
before the Promise returned by connectReader() resolves.
In this case, you will receive this sequence of events:

1. StartInstallingUpdate
2. ReaderSoftwareUpdateProgress (repeatedly)
3. FinishInstallingUpdates
4. ConnectedReader
5. connectReader() Promise resolves

Your app should show UI to the user indicating that a software update is being installed
to explain why connecting is taking longer than usual.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Only applicable to Bluetooth and USB readers.

Emitted periodically while reader software is updating to inform of the installation progress.
progress is a float between 0 and 1.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when reader software installation finishes. The callback contains
either the installed update or an error.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Only applicable to Bluetooth and USB readers.

Emitted upon connection and every 10 minutes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Only applicable to Bluetooth and USB readers.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the Terminal requests that a message be displayed in your app.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the reader begins waiting for input. Your app should prompt the customer
to present a source using one of the given input options. If the reader emits a message,
the RequestDisplayMessage event will be emitted.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Emitted when the Terminal SDK's payment collection status changes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Emitted when automatic reader reconnection begins.

addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Emitted when automatic reader reconnection succeeds.

addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Emitted when automatic reader reconnection fails.

addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

各 addListener オーバーロードは個別のメソッドシグネチャです。下の TerminalEventsEnum 表はメンバー名と文字列値だけを示し、オーバーロードは繰り返しません。

DiscoveringReaders と CancelDiscoveredReaders は列挙型に含まれ、ネイティブの探索処理から送出されますが、この一覧に型付きオーバーロードはありません。

interface DiscoverReadersOptions

interface TapToPayUxConfiguration

Configuration for the Tap to Pay UX (Android only).

interface TapToPayColorScheme

Color scheme for the Tap to Pay screen.

interface IsTapToPayAccountLinkedOptions

Options for isTapToPayAccountLinked.

interface PluginListenerHandle

interface ReaderInterface

Snapshot of a Stripe Terminal reader returned by discovery or connection.

interface ReaderSoftwareUpdateInterface

Metadata for an available reader software update.

interface LocationInterface

Stripe Terminal Location assigned to a reader.

interface Cart

<a href="#cart">Cart</a> totals displayed on a reader's customer-facing screen.

interface CartLineItem

Line item displayed on a reader's customer-facing screen.

type alias TapToPayColor

'default' | string

type alias TapToPayTapZone

{ type: 'default' } | { type: 'front'; xBias: number; yBias: number } | { type: 'behind'; xBias: number; yBias: number } | { type: 'above'; bias?: number } | { type: 'below'; bias?: number } | { type: 'left'; bias?: number } | { type: 'right'; bias?: number }

TerminalResultInterface は支払い結果イベント ConfirmedPaymentIntent、CollectedPaymentIntent、Canceled、Failed の共用体です。confirmPaymentIntent() の戻り値ではなく、利便性のための別名です。

enum TerminalConnectTypes

enum TerminalEventsEnum

enum SimulateReaderUpdate

enum SimulatedCardType

enum BatteryStatus

enum UpdateTimeEstimate

enum NetworkStatus

enum LocationStatus

enum DeviceType

enum DisconnectReason

enum ConnectionStatus

enum ReaderEvent

enum ReaderDisplayMessage

enum ReaderInputOption

enum PaymentStatus

enum TapToPayDarkMode

DeviceGroup は DeviceType をリーダー画像グループへ対応付けます。画像選択用の参照専用列挙型であり、discoverReaders や connectReader には渡しません。