Reader

@JsonClass(generateAdapter = true)
class Reader @JvmOverloads() constructor(deviceType: DeviceType, @Json(name = locationlocationRaw: ExpandableLocation?, locationStatus: LocationStatus, id: String?, readerInfo: ReaderInfo?, isSimulated: Boolean, @Json(name = statusnetworkStatus: Reader.NetworkStatus?, @Json(name = serialNumberrawSerialNumber: String?, label: String?, deviceSwVersion: String?, baseUrl: String?, ipAddress: String?, livemode: Boolean?, device: BluetoothDevice?, location: Location?)

The Reader is a representation of a physical reader device.

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

Constructors

Reader
Link copied to clipboard
fun Reader(deviceType: DeviceType = DeviceType.UNKNOWN, @Json(name = locationlocationRaw: ExpandableLocation? = null, locationStatus: LocationStatus = UNKNOWN, id: String? = null, readerInfo: ReaderInfo? = null, isSimulated: Boolean = false, @Json(name = statusnetworkStatus: Reader.NetworkStatus? = null, @Json(name = serialNumberrawSerialNumber: String? = null, label: String? = null, deviceSwVersion: String? = null, baseUrl: String? = null, ipAddress: String? = null, livemode: Boolean? = null, device: BluetoothDevice? = null, location: Location? = null)

Types

Companion
Link copied to clipboard
object Companion
NetworkStatus
Link copied to clipboard
enum NetworkStatus : Enum<Reader.NetworkStatus>
Contains possible states for the network connectivity status of the reader

Functions

activate
Link copied to clipboard
fun activate(readerId: String?, stripeSessionToken: String?, location: Location?)
toDeviceInfo
Link copied to clipboard
fun toDeviceInfo(): DeviceInfo
update
Link copied to clipboard
fun update(update: ReaderSoftwareUpdate)

Properties

availableUpdate
Link copied to clipboard
var availableUpdate: ReaderSoftwareUpdate? = null
If, during connection to the reader, a ReaderSoftwareUpdate is found that is not yet required, it will be stored in this field for future installation.
baseUrl
Link copied to clipboard
val baseUrl: String? = null
The base url for this reader (Only set for internet connected readers)
batteryLevel
Link copied to clipboard
val batteryLevel: Float?
Get the current battery level as a boxed float in the range 0, 1.
bootloaderVersion
Link copied to clipboard
val bootloaderVersion: String? = null
configVersion
Link copied to clipboard
var configVersion: String?
device
Link copied to clipboard
val device: BluetoothDevice? = null
Raw bluetooth device information (Only set for bluetoooth connected readers)
deviceType
Link copied to clipboard
val deviceType: DeviceType
Get the DeviceType of this reader
emvKeyProfileId
Link copied to clipboard
val emvKeyProfileId: String?
firmwareVersion
Link copied to clipboard
var firmwareVersion: String?
hardwareVersion
Link copied to clipboard
val hardwareVersion: String?
id
Link copied to clipboard
var id: String?
An identifier for the reader
ipAddress
Link copied to clipboard
val ipAddress: String? = null
The ip address of this reader.
isSimulated
Link copied to clipboard
val isSimulated: Boolean = false
Return whether this reader is simulated
label
Link copied to clipboard
val label: String? = null
A custom label that may be given to a reader for easier identification.
livemode
Link copied to clipboard
val livemode: Boolean? = null
Whether this reader is in livemode
location
Link copied to clipboard
var location: Location?
Get the Location this reader is registered to, if any
locationStatus
Link copied to clipboard
var locationStatus: LocationStatus
Get the LocationStatus of this reader, to know what can be expected in the registeredLocation field
macKeyProfileId
Link copied to clipboard
val macKeyProfileId: String?
networkStatus
Link copied to clipboard
val networkStatus: Reader.NetworkStatus? = null
The networking status of the reader: either offline or online.
pinKeyProfileId
Link copied to clipboard
val pinKeyProfileId: String?
pinKeysetId
Link copied to clipboard
var pinKeysetId: String?
rawReaderData
Link copied to clipboard
val rawReaderData: Map<String, String>?
registeredLocation
Link copied to clipboard
val registeredLocation: Location?
serialNumber
Link copied to clipboard
val serialNumber: String?
Get the serial number of this reader
settingsVersion
Link copied to clipboard
var settingsVersion: String? = null
softwareVersion
Link copied to clipboard
var softwareVersion: String
Get the current software version on the reader, expressed as a string
trackKeyProfileId
Link copied to clipboard
val trackKeyProfileId: String?