API

method initialize(...)

Initialisiert das Stripe Terminal SDK und seinen Anbieter für Verbindungstoken.
Vor der Lesegerätesuche einmal aufrufen.

Wenn tokenProviderEndpoint angegeben ist, sendet das Plugin eine POST-Anfrage
und erwartet { secret: string }. Wenn der Wert fehlt, stattdessen
RequestedConnectionToken behandeln und setConnectionToken() aufrufen.

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

method discoverReaders(...)

Sucht Lesegeräte mit der gewünschten Verbindungsart. Die zurückgegebenen Lesegeräte sind
Momentaufnahmen; auf DiscoveredReaders reagieren, wenn die fortlaufende Suche
weitere Ergebnisse liefern kann.

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

method setConnectionToken(...)

Übergibt ein Verbindungstoken-Secret, nachdem RequestedConnectionToken
ausgelöst wurde. Jeden Token auf dem Server erstellen und nur einmal verwenden.

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

method setSimulatorConfiguration(...)

Konfiguriert das im Testmodus verwendete simulierte Lesegerät. Vor dem
Vorgang aufrufen, dessen Verhalten Sie simulieren möchten.

Referenz in der Stripe-Dokumentation

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

method connectReader(...)

Verbindet ein von discoverReaders() zurückgegebenes Lesegerät.

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

method getConnectedReader()

Liefert das aktuell verbundene Lesegerät oder null, wenn keine Verbindung besteht.

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

method disconnectReader()

Trennt die Verbindung zum aktiven Lesegerät. Wird sofort aufgelöst, wenn keines verbunden ist.

disconnectReader() => Promise<void>

method cancelDiscoverReaders()

Bricht die aktive Lesegerätesuche ab.

cancelDiscoverReaders() => Promise<void>

method collectPaymentMethod(...)

Erfasst eine Zahlungsmethode für einen serverseitig erstellten PaymentIntent. Den
erfassten Intent mit confirmPaymentIntent() bestätigen.

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

method cancelCollectPaymentMethod()

Bricht einen laufenden Aufruf von collectPaymentMethod() ab.

cancelCollectPaymentMethod() => Promise<void>

method confirmPaymentIntent()

Bestätigt den zuletzt vom Lesegerät erfassten PaymentIntent.

confirmPaymentIntent() => Promise<void>

method installAvailableUpdate()

Installiert das durch ReportAvailableUpdate gemeldete Softwareupdate.

installAvailableUpdate() => Promise<void>

method cancelInstallUpdate()

Bricht ein laufendes optionales Softwareupdate für das Lesegerät ab.

cancelInstallUpdate() => Promise<void>

method setReaderDisplay(...)

Zeigt Warenkorbdaten auf einem Lesegerät mit kundenseitigem Bildschirm an.

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

method clearReaderDisplay()

Löscht die Warenkorbdaten aus der kundenseitigen Anzeige des Lesegeräts.

clearReaderDisplay() => Promise<void>

method rebootReader()

Startet das verbundene Lesegerät neu. Welche Lesegerätetypen unterstützt werden, hängt von der Plattform ab.

rebootReader() => Promise<void>

method cancelReaderReconnection()

Bricht einen automatischen Versuch zur Wiederherstellung der Lesegeräteverbindung ab.

cancelReaderReconnection() => Promise<void>

method setTapToPayUxConfiguration(...)

Die Darstellung der Tap-to-Pay-Bedienoberfläche konfigurieren (nur Android).
Nach initialize(), aber vor connectReader() aufrufen.
Hat auf iOS- und Webplattformen keine Wirkung.

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

method isTapToPayAccountLinked(...)

Prüfen, ob der Händler die Geschäftsbedingungen von Apple für Tap to Pay auf dem iPhone
akzeptiert hat.

Nur iOS; erfordert iOS 16.4 oder neuer. initialize() muss zuvor
aufgerufen worden sein, da das SDK einen Anbieter für Verbindungstoken benötigt. Eine
Lesegeräteverbindung ist jedoch nicht erforderlich, und der Aufruf aktiviert das Gerät nicht.

Die Antwort wird bei jedem Aufruf von Apple abgerufen. Die Anforderungen von Apple für Tap to Pay auf dem iPhone
schreiben vor, dass der Zustimmungsstatus von Apple abgefragt werden muss
statt aus einer lokalen Variable. Speichern Sie das Ergebnis daher nicht im Cache.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.Loaded, ...)

Wird nach der Initialisierung des Terminal SDK ausgelöst.

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

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Wird ausgelöst, wenn das SDK einen Verbindungstoken benötigt und kein Token-Endpunkt
konfiguriert wurde. Darauf mit einem Aufruf von setConnectionToken() reagieren.

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

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Wird ausgelöst, sobald die Suche eine aktualisierte Liste der Lesegeräte liefert. Bei der Bluetooth-Suche unter iOS
kann dieses Ereignis mehrmals ausgelöst werden.

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, ...)

Wird ausgelöst, nachdem ein Lesegerät erfolgreich verbunden wurde.

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

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Wird ausgelöst, wenn das Lesegerät getrennt wird, entweder als Reaktion auf disconnectReader()
oder aufgrund eines Verbindungsfehlers.

Bei allen Lesegerätetypen wird dieses Ereignis als Reaktion auf disconnectReader()
ohne die Eigenschaft reason ausgelöst.

Bei Bluetooth- und USB-Lesegeräten wird es mit der Eigenschaft reason ausgelöst, wenn das Lesegerät getrennt wird.

Hinweis: Bei Bluetooth- und USB-Lesegeräten wird dieses Ereignis beim Aufruf von disconnectReader()
zweimal ausgelöst: zunächst ohne reason als Bestätigung des Aufrufs und erneut mit reason, wenn das Lesegerät
die Trennung abgeschlossen hat.

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

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Wird ausgelöst, wenn sich der Verbindungsstatus von Terminal ändert.

Hinweis: Diese Methode sollte nicht verwendet werden, um einen unerwarteten Verbindungsabbruch eines Lesegeräts zur App zu erkennen,
da sie erwartete und unerwartete Verbindungsabbrüche nicht zuverlässig unterscheiden kann.

Um unerwartete Verbindungsabbrüche zu erkennen, etwa für eine automatische Benachrichtigung der Nutzer, sollte stattdessen
das Ereignis UnexpectedReaderDisconnect verwendet werden.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

Terminal wurde unerwartet vom Lesegerät getrennt.

In Ihrer Implementierung dieser Methode können Sie die Nutzer über den Verbindungsabbruch informieren.
Sie können außerdem discoverReaders() aufrufen, um nach Lesegeräten zu suchen, und versuchen,
die Verbindung zum getrennten Lesegerät automatisch wiederherzustellen. Legen Sie dabei entweder ein Zeitlimit fest oder ermöglichen Sie
den Abbruch von discoverReaders()-Aufrufen.

Bei einer Verbindung mit einem Bluetooth- oder USB-Lesegerät erhalten Sie weitere Informationen zum Verbindungsabbruch, indem Sie
das Ereignis DisconnectedReader behandeln.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Wird nach einem erfolgreichen Aufruf von confirmPaymentIntent() ausgelöst.

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

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Wird nach einem erfolgreichen Aufruf von collectPaymentMethod() ausgelöst.

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

method addListener(TerminalEventsEnum.Canceled, ...)

Wird ausgelöst, wenn cancelCollectPaymentMethod() aufgerufen wird und erfolgreich ist.
Das von cancelCollectPaymentMethod() zurückgegebene Promise wird ebenfalls aufgelöst.

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

method addListener(TerminalEventsEnum.Failed, ...)

Wird ausgelöst, wenn collectPaymentMethod() oder confirmPaymentIntent()
fehlschlägt. Das vom jeweiligen Aufruf zurückgegebene Promise wird ebenfalls abgelehnt.

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

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Wird ausgelöst, wenn ein Softwareupdate für das verbundene Lesegerät verfügbar ist.

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

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird ausgelöst, wenn das verbundene Lesegerät mit der Installation eines Softwareupdates beginnt.
Ist beim ersten Verbindungsaufbau eines Lesegeräts ein verpflichtendes Softwareupdate verfügbar, wird es
automatisch installiert. Das Update wird vor dem Ereignis ConnectedReader und
vor der Auflösung des von connectReader() zurückgegebenen Promise installiert.
In diesem Fall erhalten Sie die Ereignisse in folgender Reihenfolge:

1. StartInstallingUpdate
2. ReaderSoftwareUpdateProgress (wiederholt)
3. FinishInstallingUpdates
4. ConnectedReader
5. Das Promise von connectReader() wird aufgelöst

Ihre App sollte den Nutzern anzeigen, dass ein Softwareupdate installiert wird,
um zu erklären, warum der Verbindungsaufbau länger als üblich dauert.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird während der Aktualisierung der Lesegerätesoftware regelmäßig ausgelöst, um über den Installationsfortschritt zu informieren.
progress ist eine Fließkommazahl zwischen 0 und 1.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird ausgelöst, wenn die Installation der Lesegerätesoftware abgeschlossen ist. Der Callback enthält
entweder das installierte Update oder einen Fehler.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird beim Verbindungsaufbau und danach alle 10 Minuten ausgelöst.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird ausgelöst, wenn Terminal die Anzeige einer Meldung in Ihrer App anfordert.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Gilt nur für Bluetooth- und USB-Lesegeräte.

Wird ausgelöst, wenn das Lesegerät auf eine Eingabe zu warten beginnt. Ihre App sollte den Kunden auffordern,
eine Zahlungsquelle mit einer der angegebenen Eingabemöglichkeiten bereitzustellen. Gibt das Lesegerät eine Meldung aus,
wird das Ereignis RequestDisplayMessage ausgelöst.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Wird ausgelöst, wenn sich der Status der Zahlungserfassung im Terminal SDK ändert.

Referenz in der Stripe-Dokumentation

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

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Wird ausgelöst, wenn die automatische Wiederherstellung der Lesegeräteverbindung beginnt.

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

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Wird ausgelöst, wenn die automatische Wiederherstellung der Lesegeräteverbindung erfolgreich ist.

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

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Wird ausgelöst, wenn die automatische Wiederherstellung der Lesegeräteverbindung fehlschlägt.

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

Jede Überladung von addListener hat eine eigene Methodensignatur. Die Tabelle TerminalEventsEnum unten enthält nur die Namen der Einträge und ihre Zeichenfolgenwerte; die Überladungen werden dort nicht wiederholt.

DiscoveringReaders und CancelDiscoveredReaders sind in der Enumeration enthalten und werden von der nativen Suche ausgelöst. In dieser Liste haben sie jedoch keine typisierte Überladung.

interface DiscoverReadersOptions

interface TapToPayUxConfiguration

Konfiguration für die Tap-to-Pay-Bedienoberfläche (nur Android).

interface TapToPayColorScheme

Farbschema für die Tap-to-Pay-Oberfläche.

interface IsTapToPayAccountLinkedOptions

Optionen für isTapToPayAccountLinked.

interface PluginListenerHandle

interface ReaderInterface

Momentaufnahme eines Stripe-Terminal-Lesegeräts, die bei Suche oder Verbindung zurückgegeben wird.

interface ReaderSoftwareUpdateInterface

Metadaten eines verfügbaren Softwareupdates für das Lesegerät.

interface LocationInterface

Einem Lesegerät zugewiesene Stripe Terminal Location.

interface Cart

Cart-Gesamtbeträge, die auf dem kundenseitigen Bildschirm eines Lesegeräts angezeigt werden.

interface CartLineItem

Position, die auf dem kundenseitigen Bildschirm eines Lesegeräts angezeigt wird.

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 ist eine Union aus Ereignisnamen für Zahlungsergebnisse: TerminalEventsEnum.ConfirmedPaymentIntent, CollectedPaymentIntent, Canceled und Failed. Der Alias dient der Vereinfachung und ist kein Rückgabetyp von 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 ordnet einem DeviceType eine Gruppe von Lesegerätebildern zu (stripe_m2, chipper, wisepad, wisepose, s700, apple, tapToPayDevice, unknown). Die Enumeration dient nur als Referenz zur Bildauswahl; sie wird nicht an discoverReaders oder connectReader übergeben.