StripeTerminalPlugin | capacitor-stripe-terminal

Hierarchy

StripeTerminalPlugin

Index

Properties

Accessors

Properties

Private _fetchConnectionToken

_fetchConnectionToken: (() => Promise<string>) = ...

Type declaration

- (): Promise<string>
- Returns Promise<string>

Private _onUnexpectedReaderDisconnect

_onUnexpectedReaderDisconnect: (() => void) = ...

Type declaration

- (): void
- Returns void

Private isCollectingPaymentMethod

isCollectingPaymentMethod: boolean = false

Private isDiscovering

isDiscovering: boolean = false

isInitialized

isInitialized: boolean = false

Private listeners

listeners: {} = {}

Type declaration

[key: string]: PluginListenerHandle

Private selectedSdkType

selectedSdkType: "native" | "js" = 'native'

Private simulatedCardType

simulatedCardType: SimulatedCardType

Private Optional stripeTerminalWeb

stripeTerminalWeb?: StripeTerminalWeb

Accessors

Private activeSdkType

get activeSdkType(): "native" | "js"

- Defined in plugin.ts:52
Returns "native" | "js"

Private sdk

get sdk(): StripeTerminalInterface

- Defined in plugin.ts:65
Returns StripeTerminalInterface

Methods

Private _listenerToObservable

_listenerToObservable(name: "didReportReaderSoftwareUpdateProgress" | "didRequestReaderDisplayMessage" | "didRequestReaderInput" | "didReportAvailableUpdate" | "didStartInstallingUpdate" | "didFinishInstallingUpdate", transformFunc?: ((data: any) => any)): Observable<any>

- Defined in plugin.ts:213
Parameters
- name: "didReportReaderSoftwareUpdateProgress" | "didRequestReaderDisplayMessage" | "didRequestReaderInput" | "didReportAvailableUpdate" | "didStartInstallingUpdate" | "didFinishInstallingUpdate"
- Optional transformFunc: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
Returns Observable<any>

addListener

addListener(eventName: string, listenerFunc: Function): Promise<PluginListenerHandle>

- Defined in plugin.ts:802
This should not be used directly. It will not behave correctly when using Internet and Both discovery methods

deprecated
This should not be used directly. It will not behave correctly when using Internet and Both discovery methods

Parameters
- eventName: string
- listenerFunc: Function
Returns Promise<PluginListenerHandle>

cancelCollectPaymentMethod

cancelCollectPaymentMethod(): Promise<void>

- Defined in plugin.ts:666
Returns Promise<void>

cancelDiscoverReaders

cancelDiscoverReaders(): Promise<void>

- Defined in plugin.ts:318
Returns Promise<void>

cancelInstallUpdate

cancelInstallUpdate(): Promise<void>

- Defined in plugin.ts:577
Returns Promise<void>

clearCachedCredentials

clearCachedCredentials(): Promise<void>

- Defined in plugin.ts:680
Returns Promise<void>

clearReaderDisplay

clearReaderDisplay(): Promise<void>

- Defined in plugin.ts:697
Returns Promise<void>

collectPaymentMethod

collectPaymentMethod(): Promise<PaymentIntent>

- Defined in plugin.ts:647
Returns Promise<PaymentIntent>

connectBluetoothReader

connectBluetoothReader(reader: Reader, config: BluetoothConnectionConfiguration): Promise<Reader>

- Defined in plugin.ts:439
Parameters
- reader: Reader
- config: BluetoothConnectionConfiguration
Returns Promise<Reader>

connectInternetReader

connectInternetReader(reader: Reader, config?: InternetConnectionConfiguration): Promise<Reader>

- Defined in plugin.ts:456
Parameters
- reader: Reader
- Optional config: InternetConnectionConfiguration
Returns Promise<Reader>

connectReader

connectReader(reader: Reader): Promise<Reader>

- Defined in plugin.ts:482
This is only here for backwards compatibility

deprecated
Parameters
- reader: Reader
Returns Promise<Reader>
Reader

connectionStatus

connectionStatus(): Observable<ConnectionStatus>

- Defined in plugin.ts:516
Returns Observable<ConnectionStatus>

didFinishInstallingUpdate

didFinishInstallingUpdate(): Observable<{ error?: string; update?: ReaderSoftwareUpdate }>

- Defined in plugin.ts:625
Returns Observable<{ error?: string; update?: ReaderSoftwareUpdate }>

didReportAvailableUpdate

didReportAvailableUpdate(): Observable<ReaderSoftwareUpdate>

- Defined in plugin.ts:598
Returns Observable<ReaderSoftwareUpdate>

didReportReaderSoftwareUpdateProgress

didReportReaderSoftwareUpdateProgress(): Observable<number>

- Defined in plugin.ts:616
Returns Observable<number>

didRequestReaderDisplayMessage

didRequestReaderDisplayMessage(): Observable<ReaderDisplayMessage>

- Defined in plugin.ts:589
Returns Observable<ReaderDisplayMessage>

didRequestReaderInput

didRequestReaderInput(): Observable<ReaderInputOptions>

- Defined in plugin.ts:583
Returns Observable<ReaderInputOptions>

didStartInstallingUpdate

didStartInstallingUpdate(): Observable<ReaderSoftwareUpdate>

- Defined in plugin.ts:607
Returns Observable<ReaderSoftwareUpdate>

disconnectReader

disconnectReader(): Promise<void>

- Defined in plugin.ts:510
Returns Promise<void>

discoverReaders

discoverReaders(options: DiscoveryConfiguration): Observable<Reader[]>

- Defined in plugin.ts:351
Parameters
- options: DiscoveryConfiguration
Returns Observable<Reader[]>

Private ensureInitialized

ensureInitialized(): void

- Defined in plugin.ts:266
Returns void

getConnectedReader

getConnectedReader(): Promise<Reader>

- Defined in plugin.ts:486
Returns Promise<Reader>

getConnectionStatus

getConnectionStatus(): Promise<ConnectionStatus>

- Defined in plugin.ts:494
Returns Promise<ConnectionStatus>

getDeviceStyleFromDeviceType

getDeviceStyleFromDeviceType(type: DeviceType): DeviceStyle

- Defined in plugin.ts:765
Parameters
- type: DeviceType
Returns DeviceStyle

getPaymentStatus

getPaymentStatus(): Promise<PaymentStatus>

- Defined in plugin.ts:502
Returns Promise<PaymentStatus>

getSimulatorConfiguration

getSimulatorConfiguration(): Promise<SimulatorConfiguration>

- Defined in plugin.ts:721
Returns Promise<SimulatorConfiguration>

Private init

init(): Promise<void>

- Defined in plugin.ts:116
Returns Promise<void>

installAvailableUpdate

installAvailableUpdate(): Promise<void>

- Defined in plugin.ts:571
Returns Promise<void>

Private isNative

isNative(): boolean

- Defined in plugin.ts:85
Returns boolean

listLocations

listLocations(options?: ListLocationsParameters): Promise<{ hasMore?: boolean; locations?: Location[] }>

- Defined in plugin.ts:708
Parameters
- Optional options: ListLocationsParameters
Returns Promise<{ hasMore?: boolean; locations?: Location[] }>

Private normalizeReader

normalizeReader(reader: Reader): Reader

- Defined in plugin.ts:338
Parameters
- reader: Reader
Returns Reader

Private objectExists

objectExists<T>(object: T): T

- Defined in plugin.ts:279
Ensure that an object exists and is not empty

Type Parameters
- T
Parameters
- object: T
  
  Object to check
Returns T

processPayment

processPayment(): Promise<PaymentIntent>

- Defined in plugin.ts:672
Returns Promise<PaymentIntent>

Private requestConnectionToken

requestConnectionToken(sdkType: string): void

- Defined in plugin.ts:91
Parameters
- sdkType: string
Returns void

retrievePaymentIntent

retrievePaymentIntent(clientSecret: string): Promise<PaymentIntent>

- Defined in plugin.ts:637
Parameters
- clientSecret: string
Returns Promise<PaymentIntent>

setReaderDisplay

setReaderDisplay(cart: Cart): Promise<void>

- Defined in plugin.ts:686
Parameters
- cart: Cart
Returns Promise<void>

setSimulatorConfiguration

setSimulatorConfiguration(config: SimulatorConfiguration): Promise<SimulatorConfiguration>

- Defined in plugin.ts:740
Parameters
- config: SimulatorConfiguration
Returns Promise<SimulatorConfiguration>

Private simulatedCardTypeStringToEnum

simulatedCardTypeStringToEnum(cardType: any): SimulatedCardType

- Defined in plugin.ts:714
Parameters
- cardType: any
Returns SimulatedCardType

Private translateAndroidReaderInput

translateAndroidReaderInput(data: { isAndroid?: boolean; value: string }): ReaderInputOptions

- Defined in plugin.ts:156
Parameters
- data: { isAndroid?: boolean; value: string }
  - Optional isAndroid?: boolean
  - value: string
Returns ReaderInputOptions

Static checkPermissions

checkPermissions(): Promise<PermissionStatus>

- Defined in plugin.ts:789
Returns Promise<PermissionStatus>

Static create

create(options: StripeTerminalConfig): Promise<StripeTerminalPlugin>

Creates 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
  }
})

Parameters

options: StripeTerminalConfig

StripeTerminalPlugin options.

Returns Promise<StripeTerminalPlugin>

Static getPermissions

getPermissions(): Promise<PermissionStatus>

- Defined in plugin.ts:785
deprecated
use requestPermissions and checkPermissions instead

Returns Promise<PermissionStatus>

Static requestPermissions

requestPermissions(): Promise<PermissionStatus>

- Defined in plugin.ts:793
Returns Promise<PermissionStatus>

Hierarchy

Index

Properties

Accessors

Methods

Properties

Private _fetchConnectionToken

Type declaration

Returns Promise<string>

Private _onUnexpectedReaderDisconnect

Type declaration

Returns void

Private isCollectingPaymentMethod

Private isDiscovering

isInitialized

Private listeners

Type declaration

[key: string]: PluginListenerHandle

Private selectedSdkType

Private simulatedCardType

Private Optional stripeTerminalWeb

Accessors

Private activeSdkType

Returns "native" | "js"

Private sdk

Returns StripeTerminalInterface

Methods

Private _listenerToObservable

Parameters

name: "didReportReaderSoftwareUpdateProgress" | "didRequestReaderDisplayMessage" | "didRequestReaderInput" | "didReportAvailableUpdate" | "didStartInstallingUpdate" | "didFinishInstallingUpdate"

Optional transformFunc: ((data: any) => any)

Parameters

data: any

Returns any

Returns Observable<any>

addListener

Parameters

eventName: string

listenerFunc: Function

Returns Promise<PluginListenerHandle>

cancelCollectPaymentMethod

Returns Promise<void>

cancelDiscoverReaders

Returns Promise<void>

cancelInstallUpdate

Returns Promise<void>

clearCachedCredentials

Returns Promise<void>

clearReaderDisplay

Returns Promise<void>

collectPaymentMethod

Returns Promise<PaymentIntent>

connectBluetoothReader

Parameters

reader: Reader

config: BluetoothConnectionConfiguration

Returns Promise<Reader>

connectInternetReader

Parameters

reader: Reader

Optional config: InternetConnectionConfiguration

Returns Promise<Reader>

connectReader

Parameters

reader: Reader

Returns Promise<Reader>

connectionStatus

Returns Observable<ConnectionStatus>

didFinishInstallingUpdate

Returns Observable<{ error?: string; update?: ReaderSoftwareUpdate }>

didReportAvailableUpdate

Returns Observable<ReaderSoftwareUpdate>

didReportReaderSoftwareUpdateProgress

Returns Observable<number>

didRequestReaderDisplayMessage

Returns Observable<ReaderDisplayMessage>

didRequestReaderInput

Returns Observable<ReaderInputOptions>

didStartInstallingUpdate

Returns Observable<ReaderSoftwareUpdate>