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

Delete a Reader

DELETE / v1 / terminal / readers /:id

Deletes a Reader object.

Parameters

No parameters.

Returns

Returns the Reader object that was deleted.

Response

{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "deleted": true}

Activate a Gift Card on a Reader

POST / v1 / terminal / readers /:id / activate_gift_card

Initiates a gift card activation flow on a Reader and optionally sets its balance.

Parameters

brand enum Required The brand of the gift card. Possible enum values svs SVS gift card.

More parameters

balance object
on _ behalf _ of string

Returns

Returns an updated Reader resource.

cURL

Response

{ "id": "tmr_GkoLBwI8ngxx08", "object": "terminal.reader", "action": { "activate_gift_card": {}, "api_error": null, "failure_code": null, "failure_message": null, "status": "in_progress", "type": "activate_gift_card" }, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "simulated-wpe-e448e0d1-388f-40cd-b30f-ca82de03ced6", "last_seen_at": 1783521571548, "livemode": false, "location": "tml_GczOlAw6Yx2UMe", "metadata": {}, "serial_number": "e448e0d1-388f-40cd-b30f-ca82de03ced6", "status": "online"}