@capacitor-community/stripe-terminal v5.5.2

@capacitor-community/stripe-terminal

Stripe SDK bindings for Capacitor Applications. This plugin is still in beta. We have confirmed that it works well in the demo project. Please refer to https://github.com/capacitor-community/stripe/tree/main/demo/angular for the implementation.

• Tap To Pay
• Internet
• Bluetooth
• USB

Install

npm install @capacitor-community/stripe-terminal
npx cap sync

iOS

• iOS Configure your app

Android

Add permissions to your android/app/src/main/AndroidManifest.xml file:

+ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+ <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
+ <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
+ <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+ <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />

If used in conjunction with the @capacitor-community/stripe plugin, the following settings may be necessary

Add packagingOptions to your android/app/build.gradle file:

android {
...
+  packagingOptions {
+    resources.excludes.add("org/bouncycastle/x509/*")
+  }
}

And update minSdkVersion to 26 And compileSdkVersion to 34 in your android/app/build.gradle file:

  ext {
-    minSdkVersion = 22
-    compileSdkVersion = 33
+    minSdkVersion = 26
+    compileSdkVersion = 34

Usage

(async ()=> {
  /**
   * tokenProviderEndpoint: The URL of your backend to provide a token. Use Post request to get a token.
   */
  await StripeTerminal.initialize({ tokenProviderEndpoint: 'https://example.com/token', isTest: true })
  const { readers } = await StripeTerminal.discoverReaders({
    type: TerminalConnectTypes.TapToPay,
    locationId: "**************",
  });
  await StripeTerminal.connectReader({
    reader: readers[0],
  });
  await StripeTerminal.collect({ paymentIntent: "**************" });
});

API

• initialize(...)
• discoverReaders(...)
• connectReader(...)
• getConnectedReader()
• disconnectReader()
• cancelDiscoverReaders()
• collect(...)
• cancelCollect()
• addListener(TerminalEventsEnum.Loaded, ...)
• addListener(TerminalEventsEnum.DiscoveredReaders, ...)
• addListener(TerminalEventsEnum.ConnectedReader, ...)
• addListener(TerminalEventsEnum.Completed, ...)
• addListener(TerminalEventsEnum.Canceled, ...)
• addListener(TerminalEventsEnum.Failed, ...)
• Interfaces
• Type Aliases
• Enums

initialize(...)

initialize(options: { tokenProviderEndpoint: string; isTest: boolean; }) => Promise<void>

discoverReaders(...)

discoverReaders(options: { type: TerminalConnectTypes; locationId?: string; }) => Promise<{ readers: ReaderInterface[]; }>

Returns: Promise<{ readers: ReaderInterface[]; }>

connectReader(...)

connectReader(options: { reader: ReaderInterface; }) => Promise<void>

getConnectedReader()

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

Returns: Promise<{ reader: ReaderInterface | null; }>

disconnectReader()

disconnectReader() => Promise<void>

cancelDiscoverReaders()

cancelDiscoverReaders() => Promise<void>

collect(...)

collect(options: { paymentIntent: string; }) => Promise<void>

cancelCollect()

cancelCollect() => Promise<void>

addListener(TerminalEventsEnum.Loaded, ...)

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

Returns: Promise<PluginListenerHandle>

addListener(TerminalEventsEnum.DiscoveredReaders, ...)

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

Returns: Promise<PluginListenerHandle>

addListener(TerminalEventsEnum.ConnectedReader, ...)

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

Returns: Promise<PluginListenerHandle>

addListener(TerminalEventsEnum.Completed, ...)

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

Returns: Promise<PluginListenerHandle>

addListener(TerminalEventsEnum.Canceled, ...)

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

Returns: Promise<PluginListenerHandle>

addListener(TerminalEventsEnum.Failed, ...)

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

Returns: Promise<PluginListenerHandle>

Interfaces

PluginListenerHandle

Type Aliases

ReaderInterface

{ index: number; serialNumber: string; }

Enums

TerminalConnectTypes

TerminalEventsEnum