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

collectData

fun collectData(config: CollectDataConfiguration, callback: CollectedDataCallback): Cancelable

Collects data using the hardware interfaces on the reader. Currently available on mobile readers that support magstripe.

collectInputs

fun collectInputs(collectInputsParameters: CollectInputsParameters, callback: CollectInputsResultCallback): Cancelable

Display forms and collect information from customers. Available for BBPOS WisePOS E and Stripe S700.

collectPaymentMethod

fun collectPaymentMethod(intent: PaymentIntent, callback: PaymentIntentCallback, config: CollectConfiguration = CollectConfiguration.Builder().build()): Cancelable

Collects a payment method for the given PaymentIntent.

collectRefundPaymentMethod

@JvmOverloads

fun collectRefundPaymentMethod(refundParams: RefundParameters, config: RefundConfiguration = RefundConfiguration.Builder().build(), 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

@JvmOverloads

fun collectSetupIntentPaymentMethod(intent: SetupIntent, customerConsentCollected: Boolean, config: SetupIntentConfiguration = SetupIntentConfiguration.Builder().build(), callback: SetupIntentCallback): Cancelable

Collects a payment method for a SetupIntent.

confirmPaymentIntent

@JvmOverloads

fun confirmPaymentIntent(intent: PaymentIntent, callback: PaymentIntentCallback, config: ConfirmConfiguration = ConfirmConfiguration.Builder().build())

Confirm a payment after collecting a payment method succeeds.

confirmRefund

fun confirmRefund(callback: RefundCallback)

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

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: ReaderListener?, 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: ReaderListener?, 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)

fun createSetupIntent(params: SetupIntentParameters, callback: SetupIntentCallback, createConfiguration: CreateConfiguration?)

Create a new SetupIntent with the given parameters.

disconnectReader

fun disconnectReader(callback: Callback)

Attempts to disconnect from the currently connected reader.

discoverReaders

@RequiresPermission(anyOf = ["android.permission.ACCESS_COARSE_LOCATION", "android.permission.ACCESS_FINE_LOCATION"])

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

Begins discovering readers matching the given DiscoveryConfiguration.

getReaderSettings

fun getReaderSettings(callback: ReaderSettingsCallback)

Retrieves current settings from the connected reader.

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.

rebootReader

fun rebootReader(callback: Callback)

Reboots the currently connected reader.

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.

setLocalMobileUxConfiguration

fun setLocalMobileUxConfiguration(config: LocalMobileUxConfiguration)

Modifies the visual appearance of the Tap to Pay screen.

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.

setReaderSettings

fun setReaderSettings(params: ReaderSettingsParameters, callback: ReaderSettingsCallback)

Changes settings on the connected reader.

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, discoveryConfiguration: DiscoveryConfiguration): ReaderSupportResult

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