external/com.stripe.stripeterminal.external.models

Package-level declarations

Types

ConnectionConfiguration

sealed class ConnectionConfiguration

The ConnectionConfiguration class contains configuration information for connecting to a reader.

DisconnectReason

enum DisconnectReason : Enum<DisconnectReason>

The possible reasons for which a Bluetooth or USB reader was disconnected.

DiscoveryConfiguration

interface DiscoveryConfiguration

The DiscoveryConfiguration contains configuration information relevant to the reader discovery process.

PaymentIntent

@JsonClass(generateAdapter = true)

data class PaymentIntent : Serializable

The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each PaymentIntent typically correlates with a single “cart” or customer session in your application.

Reader

@JsonClass(generateAdapter = true)

class Reader @JvmOverloads constructor(val deviceType: DeviceType = DeviceType.UNKNOWN, @Json(name = "location") locationRaw: ExpandableLocation? = null, var locationStatus: LocationStatus = UNKNOWN, id: String? = null, readerInfo: ReaderInfo? = null, val isSimulated: Boolean = false, @Json(name = "status") val networkStatus: Reader.NetworkStatus? = null, @Json(name = "serialNumber") rawSerialNumber: String? = null, val label: String? = null, deviceSwVersion: String? = null, val baseUrl: String? = null, val ipAddress: String? = null, val livemode: Boolean? = null, val bluetoothDevice: BluetoothDevice? = null, val usbDevice: UsbDevice? = null, location: Location? = null)

The Reader is a representation of a physical reader device.

ReaderBatteryInfo

data class ReaderBatteryInfo(val batteryStatus: BatteryStatus, val batteryLevel: Float?, val isCharging: Boolean?)

SetupIntent

@JsonClass(generateAdapter = true)

data class SetupIntent : Serializable

A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.

SimulatedCard

data class SimulatedCard

A SimulatedCard contains all information necessary to simulate the experience of paying with specific card brands / error conditions.

SimulatorConfiguration

data class SimulatorConfiguration(val update: SimulateReaderUpdate = UPDATE_AVAILABLE, val simulatedCard: SimulatedCard = SimulatedCard(DEFAULT_CARD_NUMBER), val simulatedTipAmount: Long? = null)

A configuration object that can be set on the main Terminal class. It's setting will dictate the behavior you see on your next connection to a simulated reader.

TerminalException

class TerminalException @JvmOverloads constructor(val errorCode: TerminalException.TerminalErrorCode, val errorMessage: String, cause: Throwable? = null, val apiError: ApiError? = null) : Exception

A TerminalException represents an error thrown during SDK operations and will contain a TerminalErrorCode and an errorMessage to provide more specific details.