Terminal

@Singleton

class Terminal

The Terminal is the top-level object for the Stripe Terminal SDK.

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Types

Companion

object Companion

Functions

cancelPaymentIntent

fun cancelPaymentIntent(intent: PaymentIntent, callback: PaymentIntentCallback)

Cancels a PaymentIntent.

cancelSetupIntent

fun cancelSetupIntent(setupIntent: SetupIntent, params: SetupIntentCancellationParameters, callback: SetupIntentCallback)

Cancel an existing SetupIntent.

clearCachedCredentials

fun clearCachedCredentials()

Clears the current connection token, saved reader sessions, and any other cached credentials. You can use this method to switch accounts in your app, e.g. to switch between live and test Stripe API keys on your backend.

clearReaderDisplay

fun clearReaderDisplay(callback: Callback)

Clears the reader display and resets it to the splash screen

collectPaymentMethod

fun collectPaymentMethod(intent: PaymentIntent, callback: PaymentIntentCallback): Cancelable

See collectPaymentMethod

fun collectPaymentMethod(intent: PaymentIntent, callback: PaymentIntentCallback, config: CollectConfiguration?): Cancelable

Collects a payment method for the given PaymentIntent.

collectRefundPaymentMethod

fun collectRefundPaymentMethod(refundParams: RefundParameters, callback: Callback): Cancelable

Initiates an in-person refund with a given set of RefundParameters by collecting the payment method that is to be refunded.

collectSetupIntentPaymentMethod

fun collectSetupIntentPaymentMethod(intent: SetupIntent, customerConsentCollected: Boolean, callback: SetupIntentCallback): Cancelable

Collects a payment method for a SetupIntent.

confirmSetupIntent

fun confirmSetupIntent(intent: SetupIntent, callback: SetupIntentCallback)

Confirm that your customer intends to set up the current or provided payment method.

connectBluetoothReader

fun connectBluetoothReader(reader: Reader, config: ConnectionConfiguration.BluetoothConnectionConfiguration, listener: BluetoothReaderListener?, connectionCallback: ReaderCallback)

Attempts to connect to the given bluetooth reader.

connectHandoffReader

fun connectHandoffReader(reader: Reader, config: ConnectionConfiguration.HandoffConnectionConfiguration, listener: HandoffReaderListener?, connectionCallback: ReaderCallback)

Attempts to connect to the given reader in handoff mode.

connectInternetReader

fun connectInternetReader(reader: Reader, config: ConnectionConfiguration.InternetConnectionConfiguration, connectionCallback: ReaderCallback)

Attempts to connect to the given internet reader.

connectLocalMobileReader

fun connectLocalMobileReader(reader: Reader, config: ConnectionConfiguration.LocalMobileConnectionConfiguration, connectionCallback: ReaderCallback)

Attempts to connect to the local device's NFC reader.

connectUsbReader

fun connectUsbReader(reader: Reader, config: ConnectionConfiguration.UsbConnectionConfiguration, listener: UsbReaderListener?, connectionCallback: ReaderCallback)

Attempts to connect to the given reader via usb.

createPaymentIntent

fun createPaymentIntent(params: PaymentIntentParameters, callback: PaymentIntentCallback)

See createPaymentIntent

fun createPaymentIntent(params: PaymentIntentParameters, callback: PaymentIntentCallback, createConfiguration: CreateConfiguration?)

Creates a new PaymentIntent with the given parameters.

createSetupIntent

fun createSetupIntent(params: SetupIntentParameters, callback: SetupIntentCallback)

Create a new SetupIntent with the given parameters.

disconnectReader

fun disconnectReader(callback: Callback)

Attempts to disconnect from the currently connected reader.

discoverReaders

fun discoverReaders(config: DiscoveryConfiguration, discoveryListener: DiscoveryListener, callback: Callback): Cancelable

Begins discovering readers matching the given DiscoveryConfiguration.

installAvailableUpdate

fun installAvailableUpdate()

Installs a pending update on the reader. The update that will be installed is whatever is currently stored in Reader.availableUpdate. This field can be set either during Terminal.connectBluetoothReader, or whenever a new update is detected. If the field changes, you will be notified via ReaderListener.onReportAvailableUpdate.

listLocations

fun listLocations(parameters: ListLocationsParameters, callback: LocationListCallback)

Returns a list of Location objects.

processPayment

fun processPayment(intent: PaymentIntent, callback: PaymentIntentCallback)

Processes a payment after collecting a payment method succeeds.

processRefund

fun processRefund(callback: RefundCallback)

Processes an in-person refund after the refund payment method has been collected.

readReusableCard

fun readReusableCard(params: ReadReusableCardParameters, callback: PaymentMethodCallback): Cancelable

Reads a card with the given parameters and returns a PaymentMethod.

retrievePaymentIntent

fun retrievePaymentIntent(clientSecret: String, callback: PaymentIntentCallback)

Retrieves a PaymentIntent with a client secret.

retrieveSetupIntent

fun retrieveSetupIntent(clientSecret: String, callback: SetupIntentCallback)

Retrieves a SetupIntent with a client secret.

setOfflineListener

fun setOfflineListener(listener: OfflineListener)

Sets an OfflineListener to the Terminal sdk, through which the application can be notified of the Terminal's transitions between offline and online states. This will replace any previous OfflineListeners that have been registered.

setReaderDisplay

fun setReaderDisplay(cart: Cart, callback: Callback)

Updates the reader display with transaction information. This method is for display purposes only and has no correlation with what the customer is actually charged. Tax and total are also not automatically calculated and must be set in Cart.

setTerminalListener

fun setTerminalListener(listener: TerminalListener)

Sets the current implementation of TerminalListener. This will replace any previous TerminalListeners that have been registered.

supportsReadersOfType

fun supportsReadersOfType(deviceType: DeviceType, discoveryMethod: DiscoveryMethod, simulated: Boolean): ReaderSupportResult

Determine whether the mobile device supports a given reader type using a particular discovery method.

Properties

connectedReader

val connectedReader: Reader?

connectionStatus

val connectionStatus: ConnectionStatus

Get the current ConnectionStatus

networkStatus

val networkStatus: NetworkStatus

Get the current NetworkStatus

offlinePaymentAmountsByCurrency

val offlinePaymentAmountsByCurrency: Map<String, Long>

Aggregates the sum of processed offline payments for the active account by currency, Returns an empty map when there is no active account for the terminal.

offlinePaymentsCount

val offlinePaymentsCount: Int

Returns the total number of processed offline payments for the active account. Would return 0 when there is active account for the terminal.

paymentStatus

val paymentStatus: PaymentStatus

Get the current PaymentStatus

simulatorConfiguration

var simulatorConfiguration: SimulatorConfiguration

The current configuration of the simulated reader. Change this field to see different behavior.