Skip to main content
Manja / Stripe
Schema2020-08-27object

terminal.reader

A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

TerminalReaderReader

object

A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader).

device_sw_version string
optionalnullable

The current software version of the reader.

maxLength:5000

device_type string
required

Type of reader, one of `bbpos_chipper2x`, `bbpos_wisepos_e`, or `verifone_P400`.

Allowed: "bbpos_chipper2x""bbpos_wisepos_e""verifone_P400"

id string
required

Unique identifier for the object.

maxLength:5000

ip_address string
optionalnullable

The local IP address of the reader.

maxLength:5000

label string
required

Custom label given to the reader for easier identification.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

location
optionalnullable

The location identifier of the reader.

metadata object
required

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "terminal.reader"

serial_number string
required

Serial number of the reader.

maxLength:5000

status string
optionalnullable

The networking status of the reader.

maxLength:5000