Attributes
- idstring
Unique identifier for the object.
- device_
typeenum Type of reader, one of
bbpos_
,wisepad3 stripe_
,m2 stripe_
,s700 bbpos_
,chipper2x bbpos_
,wisepos_ e verifone_
,P400 simulated_
, orwisepos_ e mobile_
.phone_ reader Possible enum valuesbbpos_
chipper2x bbpos_
wisepad3 bbpos_
wisepos_ e mobile_
phone_ reader simulated_
wisepos_ e stripe_
m2 stripe_
s700 verifone_
P400 - labelstring
Custom label given to the reader for easier identification.
- locationnullable stringExpandable
The location identifier of the reader.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- serial_
numberstring Serial number of the reader.
- statusnullable enum
The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
Possible enum valuesoffline
online
More attributes
- objectstring
- actionnullable object
- device_
sw_ versionnullable string - ip_
addressnullable string - last_
seen_ atnullable integerPreview feature - livemodeboolean
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Creates a new Reader
object.
Parameters
- registration_
codestringRequired A code generated by the reader used for registering to an account.
- labelstring
Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
- locationstringRequired
The location to assign the reader to.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
Returns a Reader
object if creation succeeds.
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Updates a Reader
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- labelstring
The new label of the reader.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
Returns an updated Reader
object if a valid identifier was provided.
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": { "order_id": "6735" }, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Retrieves a Reader
object.
Parameters
No parameters.
Returns
Returns a Reader
object if a valid identifier was provided.
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Returns a list of Reader
objects.
Parameters
- device_
typeenum Filters readers by device type
- locationstring
A location ID to filter the response list to only readers at the specific location
- serial_
numberstring Filters readers by serial number
- statusenum
A status filter to filter readers to only offline or online readers
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
readers, starting after reader starting_
. Each entry in the array is a separate Terminal Reader
object. If no more readers are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/terminal/readers", "has_more": false, "data": [ { "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online" } {...} {...} ],}