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"}

List all Readers

GET / v1 / terminal / readers

Returns a list of Reader objects.

Parameters

• device _ type enum Filters readers by device type Possible enum values bbpos_chipper2x the related setting Chipper 2X BT reader. bbpos_wisepad3 the related setting WisePad 3 reader. bbpos_wisepos_e the related setting WisePOS E reader. mobile_phone_reader Tap to Pay device. simulated_stripe_s700 Simulated Stripe the related setting reader. simulated_stripe_s710 Simulated Stripe the related setting reader. simulated_verifone_m425 Simulated Verifone the related setting reader. simulated_verifone_p630 Simulated Verifone the related setting reader. simulated_verifone_ux700 Simulated Verifone the related setting reader. simulated_verifone_v660p Simulated Verifone V660p reader. Show 8 more
• location string A location ID to filter the response list to only readers at the specific location
• serial _ number string Filters readers by serial number
• status enum A status filter to filter readers to only offline or online readers

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit readers, starting after reader starting_after. Each entry in the array is a separate Terminal Reader object. If no more readers are available, the resulting array will be empty.

Response