Cancel the current reader action
POST / v1 / terminal / readers /:id / cancel_action
Cancels the current reader action. See Programmatic Cancellation for more details.
Parameters
No parameters.
Returns
Returns an updated Reader resource.
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": 1695402450407, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}
Cashout a Gift Card on a Reader
POST / v1 / terminal / readers /:id / cashout_gift_card
Initiates a gift card cashout flow on a Reader. A cashout sets the gift card balance to 0.
Parameters
- brand enum Required The brand of the gift card. Possible enum values
svsSVS gift card.
More parameters
- on _ behalf _ of string
Returns
Returns an updated Reader resource.
cURL
Response
{ "id": "tmr_GkoLBwI8ngxx08", "object": "terminal.reader", "action": { "api_error": null, "cashout_gift_card": {}, "failure_code": null, "failure_message": null, "status": "in_progress", "type": "cashout_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": 1783521739952, "livemode": false, "location": "tml_GczOlAw6Yx2UMe", "metadata": {}, "serial_number": "e448e0d1-388f-40cd-b30f-ca82de03ced6", "status": "online"}
Check a Gift Card Balance on a Reader
POST / v1 / terminal / readers /:id / check_gift_card_balance
Initiates a gift card balance check flow on a Reader.
Parameters
- brand enum Required The brand of the gift card. Possible enum values
svsSVS gift card.
More parameters
- on _ behalf _ of string
Returns
Returns an updated Reader resource.
cURL
Response
{ "id": "tmr_GkoLBwI8ngxx08", "object": "terminal.reader", "action": { "api_error": null, "check_gift_card_balance": {}, "failure_code": null, "failure_message": null, "status": "in_progress", "type": "check_gift_card_balance" }, "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": 1783521765728, "livemode": false, "location": "tml_GczOlAw6Yx2UMe", "metadata": {}, "serial_number": "e448e0d1-388f-40cd-b30f-ca82de03ced6", "status": "online"}