Create a Reader
POST / v1 / terminal / readers
Creates a new Reader object.
Parameters
- registration _ code string Required A code generated by the reader used for registering to an account.
- label string Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
- location string Required The location to assign the reader to.
- metadata map 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.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "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"}
Update a Reader
POST / v1 / terminal / readers /:id
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- label string The new label of the reader.
- metadata map 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.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "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"}
Retrieve a Reader
GET / v1 / terminal / readers /:id
Retrieves a Reader object.
Parameters
No parameters.
Returns
Returns a Reader object if a valid identifier was provided.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "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"}