Readers

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Was this section helpful? Yes No

Create a Reader

POST / v1 / terminal / readers

Update a Reader

POST / v1 / terminal / readers /:id

Retrieve a Reader

GET / v1 / terminal / readers /:id

List all Readers

GET / v1 / terminal / readers

Delete a Reader

DELETE / v1 / terminal / readers /:id

Activate a Gift Card on a Reader

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

Cancel the current reader action

POST / v1 / terminal / readers /:id / cancel_action

Cashout a Gift Card on a Reader

POST / v1 / terminal / readers /:id / cashout_gift_card

Check a Gift Card Balance on a Reader

POST / v1 / terminal / readers /:id / check_gift_card_balance

Collect inputs using a Reader

POST / v1 / terminal / readers /:id / collect_inputs

Confirm a PaymentIntent on the Reader

POST / v1 / terminal / readers /:id / confirm_payment_intent

Hand off a PaymentIntent to a Reader and collect card details

POST / v1 / terminal / readers /:id / collect_payment_method

Hand-off a PaymentIntent to a Reader

POST / v1 / terminal / readers /:id / process_payment_intent

Hand-off a SetupIntent to a Reader

POST / v1 / terminal / readers /:id / process_setup_intent

Print content on a reader

POST / v1 / terminal / readers /:id / print_content

Refund a Charge or a PaymentIntent in-person

POST / v1 / terminal / readers /:id / refund_payment

Reload a Gift Card on a Reader

POST / v1 / terminal / readers /:id / reload_gift_card

Set reader display

POST / v1 / terminal / readers /:id / set_reader_display

Simulate a successful input collection

POST / v1 / test_helpers / terminal / readers /:id / succeed_input_collection

Simulate an input collection timeout

POST / v1 / test_helpers / terminal / readers /:id / timeout_input_collection

Simulate presenting a payment method

POST / v1 / test_helpers / terminal / readers /:id / present_payment_method

The Reader object

Attributes

• id string Unique identifier for the object.
• device _ type enum Device type of the reader. 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
• label string Custom label given to the reader for easier identification.
• location nullable string Expandable The location identifier 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.
• serial _ number string Serial number of the reader.
• status nullable enum The networking status of the reader. We do not recommend using this field in flows that may block taking payments. Possible enum values offline online

More attributes

• object string, value is "terminal.reader"
• action nullable object
• device _ sw _ version nullable string
• ip _ address nullable string
• last _ seen _ at nullable timestamp
• livemode boolean

The Reader object

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

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