Sample - Stripe API
GET/v1/terminal/readers/{reader}

Retrieve a Terminal reader

Retrieves a specific Terminal reader by its identifier. Use expand when you need additional response fields expanded instead of returned as identifiers.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
readerstringrequired
The unique identifier of the reader to retrieve. Must be no longer than 5000 characters.
expandarray<string>optional
Fields to expand in the response; each field name must be no longer than 5000 characters.

2 status codes
200Returns the requested reader object, or a deleted-reader representation when the reader has been deleted.
actionobjectoptional
The most recent action performed by the reader.
device_sw_versionstringoptional
The current software version of the reader.
device_typestringrequired
Device type of the reader.
Allowed:bbpos_chipper2xbbpos_wisepad3bbpos_wisepos_emobile_phone_readersimulated_stripe_s700simulated_stripe_s710simulated_verifone_m425simulated_verifone_p630simulated_verifone_ux700simulated_verifone_v660psimulated_wisepos_estripe_m2
idstringrequired
Unique identifier for the object.
ip_addressstringoptional
The local IP address of the reader.
labelstringrequired
Custom label given to the reader for easier identification.
last_seen_atintegeroptional
The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
locationstringoptional
The location identifier of the reader.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:terminal.reader
serial_numberstringrequired
Serial number of the reader.
statusstringoptional
The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
Allowed:offlineonline
defaultError response.
errorobjectrequired

Error handling

reader must be a string no longer than 5000 characters and must identify the reader to retrieve. Each value in expand must be a string no longer than 5000 characters.