Set reader display
POST / v1 / terminal / readers /:id / set_reader_display
Sets the reader display to show cart details.
Parameters
- type enum Required Type of information to display. Only
cartis currently supported. - cart object Cart details to display on the reader screen, including line items, amounts, and currency.
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "set_reader_display": { "cart": { "currency": "usd", "line_items": [ { "amount": 5100, "description": "Red t-shirt", "quantity": 1 } ], "tax": 100, "total": 5200 }, "type": "cart" }, "status": "in_progress", "type": "set_reader_display" }, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1695166525506, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Simulate a successful input collection Test helper
POST / v1 / test_helpers / terminal / readers /:id / succeed_input_collection
Use this endpoint to trigger a successful input collection on a simulated reader.
Parameters
- skip _ non _ required _ inputs enum This parameter defines the skip behavior for input collection.
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": null, "failure_message": null, "collect_inputs": { "inputs": [ { "type": "signature", "custom_text": { "title": "Signature", "description": "Please sign below", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "signature": { "value": "file_abcd" } }, { "type": "selection", "custom_text": { "title": "Selection", "description": "Please select one" }, "required": true, "selection": { "choices": [ { "style": "primary", "value": "choice_1" }, { "style": "secondary", "value": "choice_2" } ], "value": "choice_1" } }, { "type": "email", "custom_text": { "title": "Enter your email", "description": "We'll send updates on your order and occasional deals", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "email": { "value": "someone@example.com" } } ] }, "status": "succeeded", "type": "collect_inputs" }, "device_deploy_group": null, "device_sw_version": null, "device_type": "bbpos_wisepos_e", "ip_address": "192.168.2.2", "label": "Blue Rabbit", "livemode": false, "location": null, "metadata": {}, "serial_number": "123-456-789", "status": "online"}
Simulate an input collection timeout Test helper
POST / v1 / test_helpers / terminal / readers /:id / timeout_input_collection
Use this endpoint to complete an input collection with a timeout error on a simulated reader.
Parameters
No parameters.
Returns
Returns an updated Reader resource.
Response
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": { "failure_code": "collect_inputs_timeout", "failure_message": "collect inputs was timed out", "collect_inputs": { "inputs": [ { "type": "signature", "custom_text": { "title": "Signature", "description": "Please sign below", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "signature": { "value": null } }, { "type": "selection", "custom_text": { "title": "Selection", "description": "Please select one" }, "required": true, "selection": { "choices": [ { "style": "primary", "value": "choice_1" }, { "style": "secondary", "value": "choice_2" } ], "value": null } }, { "type": "email", "custom_text": { "title": "Enter your email", "description": "We'll send updates on your order and occasional deals", "submit_button": "Submit", "skip_button": "Skip" }, "required": false, "email": { "value": null } } ] }, "status": "failed", "type": "collect_inputs" }, "device_deploy_group": null, "device_sw_version": null, "device_type": "bbpos_wisepos_e", "ip_address": "192.168.2.2", "label": "Blue Rabbit", "livemode": false, "location": null, "metadata": {}, "serial_number": "123-456-789", "status": "online"}