Package-level declarations
Types
The Callback
interface represents the simplest set of methods to run upon completion of an operation. If the operation completes with error, the onFailure
method will be called. If, instead, the operation completes with no error, the onSuccess
method will be called.
A Cancelable
represents an ongoing operation run by the Terminal SDK. While the operation runs, the Cancelable allows the user to check whether it has completed or cancel it if necessary.
CollectInputsResultCallback is an interface for callbacks that will receive a CollectInputsResult under the success case, and a TerminalException under the failure case.
The ConnectionTokenCallback
will be used for the Stripe Terminal SDK to handle the result of the user's ConnectionTokenProvider.
Before integrating the SDK, you should create an endpoint on your backend server that creates a new connection token via the Stripe Terminal API. The connection token is used by the SDK to connect to a reader.
The DiscoveryListener
is notified whenever the set of Readers available for connection is updated.
ErrorCallback
is a generic callback interface used for any callback that handles exceptions.
The HandoffReaderListener interface is a listener that should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader.
The InternetReaderListener interface is a listener that should exist for the entire duration of your connection to an internet reader. It will receive events related to the status of the reader.
For callbacks that receive a list of Location objects on success.
The MobileReaderListener interface is a listener that should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader, as well as opportunities to update the reader's software.
The OfflineListener enables an application to be notified when asynchronous connection status changes related to the terminal sdk occur.
PaymentIntentCallback
is an interface for callbacks that will receive a PaymentIntent under the success case, and an Exception under the failure case.
PaymentMethodCallback
is an interface for callbacks that will receive a PaymentMethod under the success case, and an Exception under the failure case.
ReaderCallback
is an interface for callbacks that will receive a Reader under the success case, and an Exception under the failure case.
The ReaderListenable
interface is a common abstraction across the different listener interfaces. It should exist for the entire duration of your connection to a reader. It will receive events related to the status of the reader.
The ReaderReconnectionListener
is implemented in order to receive updates from auto reconnection.
ReadersCallback
is an interface for callbacks that will receive a list of Reader under the success case, and an Exception under the failure case.
ReaderSettingsCallback
is an interface for callbacks that will receive a ReaderSettings under the success case, and an Exception under the failure case.
A ReaderSoftwareUpdateCallback
is called upon completion of Terminal.checkForUpdate and will pass back a ReaderSoftwareUpdate if it's available.
RefundCallback
is an interface for callbacks that will receive a Refund under the success case, and an Exception under the failure case.
SetupIntentCallback
is an interface for callbacks that will receive a SetupIntent under the success case, and an Exception under the failure case.
The TapToPayReaderListener interface is a listener that should exist for the entire duration of your connection to a tap-to-pay reader. It will receive events related to the status of the reader.
The TerminalListener
interface should be implemented in order to receive updates from a Terminal instance.