Reader Types

`Reader.Type`

Represents a physical or simulated Stripe Terminal reader. The base fields are shared across platforms; some fields are platform-specific.

string

required

Unique identifier for the reader.

serialNumber

string

required

The reader’s serial number.

deviceType

Reader.DeviceType

required

The hardware model of the reader. See Reader.DeviceType.

status

Reader.NetworkStatus

required

Whether the reader is online or offline. See Reader.NetworkStatus.

locationStatus

LocationStatus

required

Whether a location has been assigned to this reader. See LocationStatus.

label

string

A custom label assigned to the reader in the Stripe Dashboard.

batteryLevel

number

Battery charge level as a value between 0 and 1.

locationId

string

The ID of the location the reader is registered to.

deviceSoftwareVersion

string

The version of the reader’s current firmware.

simulated

boolean

Whether this reader is a simulated reader used for testing.

availableUpdate

Reader.SoftwareUpdate

A pending software update, if one is available. See Reader.SoftwareUpdate.

ipAddress

string

The reader’s IP address (internet-connected readers only).

livemode

boolean

Whether the reader is operating in live mode.

location

Location

The full location object associated with the reader. See Location.

iOS-specific fields

batteryStatus

Reader.BatteryStatus

A categorical description of the battery level. See Reader.BatteryStatus. (iOS only)

isCharging

number

Non-zero when the reader is currently charging. (iOS only)

Android-specific fields

baseUrl

string

Base URL for the reader’s local API. (Android only)

bootloaderVersion

string

Version of the reader’s bootloader. (Android only)

configVersion

string

Version of the reader’s configuration. (Android only)

emvKeyProfileId

string

EMV key profile identifier. (Android only)

firmwareVersion

string

Version of the reader’s firmware. (Android only)

hardwareVersion

string

Version of the reader’s hardware. (Android only)

macKeyProfileId

string

MAC key profile identifier. (Android only)

pinKeyProfileId

string

PIN key profile identifier. (Android only)

trackKeyProfileId

string

Track key profile identifier. (Android only)

settingsVersion

string

Version of the reader’s settings. (Android only)

pinKeysetId

string

PIN keyset identifier. (Android only)

`Reader.DeviceType`

Identifies the physical hardware model of a reader.

type DeviceType =
  | 'chipper1X'
  | 'chipper2X'
  | 'stripeM2'
  | 'wiseCube'
  | 'wisePad3'
  | 'wisePosE'
  | 'wisePosEDevkit'
  | 'wisePad3s'
  | 'stripeS700Devkit'
  | 'stripeS700'
  | 'stripeS710Devkit'
  | 'stripeS710'
  | 'cotsDevice'
  | 'tapToPay'
  | 'etna';

Value	Description
`chipper1X`	Stripe Chipper 1X
`chipper2X`	Stripe Chipper 2X
`stripeM2`	Stripe Reader M2
`wiseCube`	Verifone WiseCube
`wisePad3`	Verifone WisePad 3
`wisePosE`	Verifone WisePOS E
`wisePosEDevkit`	Verifone WisePOS E DevKit
`wisePad3s`	Verifone WisePad 3s
`stripeS700Devkit`	Stripe S700 DevKit
`stripeS700`	Stripe Reader S700
`stripeS710Devkit`	Stripe S710 DevKit
`stripeS710`	Stripe Reader S710
`cotsDevice`	Commercial off-the-shelf Android device
`tapToPay`	Tap to Pay on iPhone or Android
`etna`	Stripe Reader ETNA

`Reader.SoftwareUpdate`

Describes a pending software update for a reader.

deviceSoftwareVersion

string

required

The version of software contained in the update.

estimatedUpdateTime

Reader.EstimatedUpdateTime

required

An estimate of how long the update will take to install. See Reader.EstimatedUpdateTime.

requiredAt

string

ISO 8601 date string after which the update will be required before the reader can be used.

`Reader.EstimatedUpdateTime`

A categorical estimate for how long a software update will take.

type EstimatedUpdateTime =
  | 'estimateLessThan1Minute'
  | 'estimate1To2Minutes'
  | 'estimate2To5Minutes'
  | 'estimate5To15Minutes';

Value	Description
`estimateLessThan1Minute`	Less than one minute
`estimate1To2Minutes`	1 to 2 minutes
`estimate2To5Minutes`	2 to 5 minutes
`estimate5To15Minutes`	5 to 15 minutes

`Reader.ConnectionStatus`

The current state of the SDK’s connection to a reader.

type ConnectionStatus =
  | 'connected'
  | 'connecting'
  | 'notConnected'
  | 'discovering'
  | 'reconnecting';

Value	Description
`connected`	A reader is connected
`connecting`	Connection is in progress
`notConnected`	No reader is connected
`discovering`	Scanning for nearby readers
`reconnecting`	Attempting to re-establish a lost connection

`Reader.NetworkStatus`

Indicates whether the reader has a network connection.

type NetworkStatus = 'offline' | 'online';

`Reader.BatteryStatus`

A categorical description of the reader’s battery level. (iOS only)

type BatteryStatus = 'critical' | 'low' | 'nominal' | 'unknown';

Value	Description
`critical`	Battery is critically low; the reader may shut down soon
`low`	Battery is low
`nominal`	Battery level is sufficient
`unknown`	Battery status cannot be determined

`Reader.BatteryLevel`

Detailed battery information emitted via the onDidUpdateBatteryLevel event.

batteryLevel

number

required

Battery charge as a value between 0 and 1.

batteryStatus

Reader.BatteryStatus

required

Categorical battery status. See Reader.BatteryStatus.

isCharging

boolean

required

Whether the reader is currently charging.

`Reader.SimulateUpdateType`

Controls the simulated software update behavior when using the simulator.

type SimulateUpdateType =
  | 'random'
  | 'available'
  | 'none'
  | 'required'
  | 'lowBattery'
  | 'lowBatterySucceedConnect'
  | 'requiredForOffline';

Value	Description
`random`	Randomly simulate an update or no update
`available`	Simulate an available (optional) update
`none`	No update available
`required`	Simulate a required update that must be installed before use
`lowBattery`	Simulate a failed update due to low battery
`lowBatterySucceedConnect`	Simulate low battery but allow connection to succeed
`requiredForOffline`	Simulate an update required for offline mode

`Reader.InputOptions`

The card input methods a reader is requesting the customer to use.

type InputOptions = 'insertCard' | 'swipeCard' | 'tapCard';

`Reader.DisplayMessage`

Messages the SDK requests be displayed to the customer during payment collection.

type DisplayMessage =
  | 'insertCard'
  | 'insertOrSwipeCard'
  | 'multipleContactlessCardsDetected'
  | 'removeCard'
  | 'retryCard'
  | 'swipeCard'
  | 'tryAnotherCard'
  | 'tryAnotherReadMethod'
  | 'checkMobileDevice'
  | 'cardRemovedTooEarly';

`Reader.DisconnectReason`

The reason a reader disconnected unexpectedly.

type DisconnectReason =
  | 'disconnectRequested'
  | 'rebootRequested'
  | 'securityReboot'
  | 'criticallyLowBattery'
  | 'poweredOff'
  | 'bluetoothDisabled'
  | 'bluetoothSignalLost'
  | 'usbDisconnected'
  | 'idlePowerDown'
  | 'unknown';

Value	Description
`disconnectRequested`	Disconnect was requested by the application
`rebootRequested`	Reader is rebooting
`securityReboot`	Reader rebooted due to a security event
`criticallyLowBattery`	Reader shut down due to critically low battery
`poweredOff`	Reader was powered off
`bluetoothDisabled`	Bluetooth was disabled on the host device
`bluetoothSignalLost`	Bluetooth signal was lost
`usbDisconnected`	USB cable was disconnected
`idlePowerDown`	Reader powered down after being idle
`unknown`	Unknown reason

`Reader.ReaderSettings`

Result type for reader settings retrieval. Contains either accessibility settings or an error.

type ReaderSettings =
  | { accessibility?: Accessibility; error?: undefined }
  | { accessibility?: undefined; error?: StripeError };

`Reader.Accessibility`

Accessibility settings for a reader.

textToSpeechStatus

Reader.ReaderTextToSpeechStatus

required

The current text-to-speech status. See Reader.ReaderTextToSpeechStatus.

error

StripeError

An error that occurred while retrieving accessibility settings.

`Reader.ReaderTextToSpeechStatus`

Indicates how text-to-speech audio is being output on a reader.

type ReaderTextToSpeechStatus = 'off' | 'headphones' | 'speakers';

Value	Description
`off`	Text-to-speech is disabled
`headphones`	Audio routed through headphones
`speakers`	Audio routed through the reader’s speakers

`Reader.ReaderSettingsParameters`

Parameters for updating reader settings.

textToSpeechViaSpeakers

boolean

required

When true, routes text-to-speech audio through the reader’s built-in speakers instead of headphones.

`Reader.ReaderSupportParams`

Parameters used to check whether a given reader configuration is supported.

deviceType

Reader.DeviceType

required

The device type to check support for.

discoveryMethod

Reader.DiscoveryMethod

required

The discovery method to check support for.

simulated

boolean

Whether to check support for the simulated variant.

`Reader.ReaderSupportResult`

Result of a reader support check.

readerSupportResult

boolean

required

Whether the specified reader configuration is supported on the current device.

error

StripeError

An error that occurred during the support check.

`Reader.DiscoveryMethod`

The method used to discover readers. Available values differ by platform.

iOS

type IOS.DiscoveryMethod =
  | 'bluetoothProximity'
  | 'bluetoothScan'
  | 'internet'
  | 'tapToPay'
  | 'usb';

USB discovery is in private preview for iPads with M-series chips. Contact Stripe support to join the preview.

Android

type Android.DiscoveryMethod =
  | 'bluetoothScan'
  | 'internet'
  | 'tapToPay'
  | 'appsOnDevices'
  | 'usb';

Value	Description
`bluetoothProximity`	Discover Bluetooth readers using proximity (iOS only)
`bluetoothScan`	Scan for Bluetooth readers
`internet`	Discover internet-connected readers
`tapToPay`	Use the device itself as a Tap to Pay reader
`usb`	Discover readers connected via USB
`appsOnDevices`	Discover readers via Apps on Devices (Android only)

`Location`

A Stripe Terminal location.

string

required

The location’s unique identifier.

livemode

boolean

required

Whether this location is in live mode.

displayName

string

Human-readable name for the location.

address

Address

The physical address of the location.

Show Address properties

city

string

City.

country

string

Two-letter country code (ISO 3166-1 alpha-2).

postalCode

string

Postal code.

line1

string

First line of the street address.

line2

string

Second line of the street address.

state

string

State, province, or region.

`Address`

A physical mailing address.

city

string

City.

country

string

Two-letter country code (ISO 3166-1 alpha-2).

postalCode

string

Postal code.

line1

string

First line of the street address.

line2

string

Second line of the street address.

state

string

State, province, or region.

`LocationStatus`

Indicates whether a location has been assigned to a reader.

type LocationStatus = 'notSet' | 'set' | 'unknown';

Value	Description
`notSet`	No location has been assigned
`set`	A location is assigned
`unknown`	Location assignment status cannot be determined

Components

Hooks

Types

`Reader.Type`

iOS-specific fields

Android-specific fields

`Reader.DeviceType`

`Reader.SoftwareUpdate`

`Reader.EstimatedUpdateTime`

`Reader.ConnectionStatus`

`Reader.NetworkStatus`

`Reader.BatteryStatus`

`Reader.BatteryLevel`

`Reader.SimulateUpdateType`

`Reader.InputOptions`

`Reader.DisplayMessage`

`Reader.DisconnectReason`

`Reader.ReaderSettings`

`Reader.Accessibility`

`Reader.ReaderTextToSpeechStatus`

`Reader.ReaderSettingsParameters`

`Reader.ReaderSupportParams`

`Reader.ReaderSupportResult`

`Reader.DiscoveryMethod`

iOS

Android

`Location`

`Address`

`LocationStatus`

Build docs developers (and LLMs) love

Components

Hooks

Types

Documentation Index

​Reader.Type

​iOS-specific fields

​Android-specific fields

​Reader.DeviceType

​Reader.SoftwareUpdate

​Reader.EstimatedUpdateTime

​Reader.ConnectionStatus

​Reader.NetworkStatus

​Reader.BatteryStatus

​Reader.BatteryLevel

​Reader.SimulateUpdateType

​Reader.InputOptions

​Reader.DisplayMessage

​Reader.DisconnectReason

​Reader.ReaderSettings

​Reader.Accessibility

​Reader.ReaderTextToSpeechStatus

​Reader.ReaderSettingsParameters

​Reader.ReaderSupportParams

​Reader.ReaderSupportResult

​Reader.DiscoveryMethod

​iOS

​Android

​Location

​Address

​LocationStatus

Build docs developers (and LLMs) love

`Reader.Type`

iOS-specific fields

Android-specific fields

`Reader.DeviceType`

`Reader.SoftwareUpdate`

`Reader.EstimatedUpdateTime`

`Reader.ConnectionStatus`

`Reader.NetworkStatus`

`Reader.BatteryStatus`

`Reader.BatteryLevel`

`Reader.SimulateUpdateType`

`Reader.InputOptions`

`Reader.DisplayMessage`

`Reader.DisconnectReason`

`Reader.ReaderSettings`

`Reader.Accessibility`

`Reader.ReaderTextToSpeechStatus`

`Reader.ReaderSettingsParameters`

`Reader.ReaderSupportParams`

`Reader.ReaderSupportResult`

`Reader.DiscoveryMethod`

iOS

Android

`Location`

`Address`

`LocationStatus`