API

method initialize(...)

Initialise le SDK Stripe Terminal et son fournisseur de jetons de connexion.
Appelez cette méthode une fois avant de découvrir les lecteurs.

Lorsque tokenProviderEndpoint est fourni, le plugin envoie une requête POST et attend { secret: string }. Si ce paramètre est omis, gérez plutôt RequestedConnectionToken et appelez setConnectionToken().

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

method discoverReaders(...)

Découvre les lecteurs avec le mode de communication demandé. Les lecteurs renvoyés sont des instantanés ; écoutez DiscoveredReaders lorsque la découverte continue peut produire des résultats supplémentaires.

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

method setConnectionToken(...)

Fournit un secret de jeton de connexion après l’émission de RequestedConnectionToken. Créez chaque jeton sur votre serveur et utilisez-le une seule fois.

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

method setSimulatorConfiguration(...)

Configure le lecteur simulé utilisé en mode test. Appelez cette méthode avant l’opération dont vous souhaitez simuler le comportement.

Référence de la documentation Stripe

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

method connectReader(...)

Se connecte à un lecteur renvoyé par discoverReaders().

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

method getConnectedReader()

Renvoie le lecteur actuellement connecté, ou null s’il est déconnecté.

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

method disconnectReader()

Déconnecte le lecteur actif. Se résout immédiatement si aucun lecteur n’est connecté.

disconnectReader() => Promise<void>

method cancelDiscoverReaders()

Annule l’opération de découverte de lecteurs en cours.

cancelDiscoverReaders() => Promise<void>

method collectPaymentMethod(...)

Recueille un moyen de paiement pour un PaymentIntent créé sur le serveur. Confirmez l’intent recueilli avec confirmPaymentIntent().

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

method cancelCollectPaymentMethod()

Annule un appel à collectPaymentMethod() en cours.

cancelCollectPaymentMethod() => Promise<void>

method confirmPaymentIntent()

Confirme le PaymentIntent recueilli le plus récemment par le lecteur.

confirmPaymentIntent() => Promise<void>

method installAvailableUpdate()

Installe la mise à jour logicielle signalée par ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

method cancelInstallUpdate()

Annule une mise à jour logicielle facultative du lecteur en cours.

cancelInstallUpdate() => Promise<void>

method setReaderDisplay(...)

Affiche les informations du panier sur un lecteur doté d’un écran destiné au client.

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

method clearReaderDisplay()

Efface les informations du panier de l’écran du lecteur destiné au client.

clearReaderDisplay() => Promise<void>

method rebootReader()

Redémarre le lecteur connecté. Les types de lecteurs pris en charge dépendent de la plateforme.

rebootReader() => Promise<void>

method cancelReaderReconnection()

Annule une tentative de reconnexion automatique du lecteur.

cancelReaderReconnection() => Promise<void>

method setTapToPayUxConfiguration(...)

Configure l’apparence de l’expérience Tap to Pay (Android uniquement).
Appelez cette méthode après initialize(), mais avant connectReader().
Sans effet sur iOS et le Web.

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

method isTapToPayAccountLinked(...)

Vérifie si le commerçant a accepté les conditions générales d’Apple pour Tap to Pay sur iPhone.

iOS uniquement, à partir d’iOS 16.4. initialize() doit avoir été appelé au préalable, car le SDK nécessite un fournisseur de jetons de connexion. Aucune connexion à un lecteur n’est toutefois requise, et l’appel n’active pas l’appareil.

La réponse est récupérée auprès d’Apple à chaque appel. Les exigences d’Apple pour Tap to Pay sur iPhone imposent de récupérer l’état d’acceptation auprès d’Apple plutôt que depuis une variable locale : ne mettez donc pas le résultat en cache.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.Loaded, ...)

Émis après l’initialisation du SDK Terminal.

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

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Émis lorsque le SDK a besoin d’un jeton de connexion et qu’aucun endpoint de jeton n’est configuré. Répondez en appelant setConnectionToken().

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

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Émis chaque fois que la découverte produit une liste de lecteurs actualisée. Lors d’une découverte Bluetooth sur iOS, cet événement peut être émis plusieurs fois.

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

Émis après la connexion réussie d’un lecteur.

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

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Émis lorsque le lecteur est déconnecté, à la suite de disconnectReader() ou d’une erreur de connexion.

Pour tous les types de lecteurs, l’appel à disconnectReader() déclenche cet événement sans propriété reason.

Pour les lecteurs Bluetooth et USB, cet événement est émis avec une propriété reason lorsque le lecteur se déconnecte.

Remarque : pour les lecteurs Bluetooth et USB, lorsque vous appelez disconnectReader(), cet événement est émis deux fois : une première fois sans reason pour accuser réception de l’appel, puis une seconde fois avec reason lorsque la déconnexion du lecteur est terminée.

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

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Émis lorsque l’état de connexion de Terminal change.

Remarque : vous ne devez pas utiliser cette méthode pour détecter une déconnexion inattendue du lecteur de votre application, car elle ne permet pas de distinguer précisément les déconnexions prévues et imprévues.

Pour détecter les déconnexions inattendues, par exemple afin d’en informer automatiquement l’utilisateur, utilisez plutôt l’événement UnexpectedReaderDisconnect.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

Terminal s’est déconnecté du lecteur de manière inattendue.

Dans votre implémentation de cette méthode, vous pouvez informer l’utilisateur de la déconnexion du lecteur. Vous pouvez également appeler discoverReaders() pour lancer la recherche de lecteurs et tenter de reconnecter automatiquement le lecteur déconnecté. Veillez à définir un délai d’expiration ou à permettre l’annulation des appels à discoverReaders().

Lorsque vous êtes connecté à un lecteur Bluetooth ou USB, vous pouvez obtenir davantage d’informations sur la déconnexion en implémentant l’événement DisconnectedReader.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Émis après la réussite de confirmPaymentIntent().

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

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Émis après la réussite de collectPaymentMethod().

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

method addListener(TerminalEventsEnum.Canceled, ...)

Émis lorsque cancelCollectPaymentMethod() est appelé et réussit.
La Promise renvoyée par cancelCollectPaymentMethod() est également résolue.

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

method addListener(TerminalEventsEnum.Failed, ...)

Émis lorsque collectPaymentMethod() ou confirmPaymentIntent() échoue. La Promise renvoyée par l’appel concerné est également rejetée.

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

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Émis lorsqu’une mise à jour logicielle est disponible pour le lecteur connecté.

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

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis lorsque le lecteur connecté commence à installer une mise à jour logicielle. Si une mise à jour obligatoire est disponible à la première connexion d’un lecteur, elle est installée automatiquement. La mise à jour est installée avant l’émission de ConnectedReader et avant la résolution de la Promise renvoyée par connectReader(). Dans ce cas, vous recevez les événements dans l’ordre suivant :

1. StartInstallingUpdate
2. ReaderSoftwareUpdateProgress (plusieurs fois)
3. FinishInstallingUpdates
4. ConnectedReader
5. Résolution de la Promise connectReader()

Votre application doit indiquer à l’utilisateur qu’une mise à jour logicielle est en cours d’installation pour expliquer pourquoi la connexion prend plus de temps que d’habitude.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis périodiquement pendant la mise à jour logicielle du lecteur pour indiquer la progression de l’installation.
progress est un nombre flottant compris entre 0 et 1.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis à la fin de l’installation du logiciel du lecteur. Le callback contient soit la mise à jour installée, soit une erreur.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis à la connexion, puis toutes les 10 minutes.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis lorsque Terminal demande l’affichage d’un message dans votre application.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Applicable uniquement aux lecteurs Bluetooth et USB.

Émis lorsque le lecteur commence à attendre une saisie. Votre application doit inviter le client à présenter un moyen de paiement en utilisant l’une des options de saisie proposées. Si le lecteur émet un message, l’événement RequestDisplayMessage est émis.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Émis lorsque l’état de collecte de paiement du SDK Terminal change.

Référence de la documentation Stripe

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

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Émis lorsque la reconnexion automatique du lecteur commence.

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

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Émis lorsque la reconnexion automatique du lecteur réussit.

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

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Émis lorsque la reconnexion automatique du lecteur échoue.

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

Chaque surcharge de addListener possède sa propre signature. Le tableau TerminalEventsEnum ci-dessous contient uniquement les noms des membres et leurs valeurs textuelles ; il ne reprend pas ces surcharges.

DiscoveringReaders et CancelDiscoveredReaders figurent dans l’énumération et sont émis par la recherche native, mais ne disposent pas de surcharge typée dans cette liste.

interface DiscoverReadersOptions

interface TapToPayUxConfiguration

Configuration de l’expérience Tap to Pay (Android uniquement).

interface TapToPayColorScheme

Palette de couleurs de l’écran Tap to Pay.

interface IsTapToPayAccountLinkedOptions

Options de isTapToPayAccountLinked.

interface PluginListenerHandle

interface ReaderInterface

Instantané d’un lecteur Stripe Terminal renvoyé par la découverte ou la connexion.

interface ReaderSoftwareUpdateInterface

Métadonnées d’une mise à jour logicielle disponible pour le lecteur.

interface LocationInterface

Stripe Terminal Location attribuée à un lecteur.

interface Cart

Totaux du Cart affichés sur l’écran du lecteur destiné au client.

interface CartLineItem

Ligne affichée sur l’écran du lecteur destiné au client.

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 est une union de noms d’événements de résultat du paiement : TerminalEventsEnum.ConfirmedPaymentIntent, CollectedPaymentIntent, Canceled et Failed. Cet alias pratique n’est pas le type de retour de 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 associe un DeviceType à un groupe d’images de lecteurs (stripe_m2, chipper, wisepad, wisepose, s700, apple, tapToPayDevice, unknown). Cette énumération sert uniquement de référence pour choisir des images ; elle ne doit pas être transmise à discoverReaders ou connectReader.