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"}
Collect inputs using a Reader
POST / v1 / terminal / readers /:id / collect_inputs
Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Parameters
- inputs array of objects Required List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.
- 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 resource.
Response
{ "id": "tmr_OXYJvwsea7PDiDHNciXRkytb", "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": null } }, { "type": "selection", "custom_text": { "title": "Selection", "description": "Please select one" }, "required": true, "selection": { "choices": [ { "style": "primary", "text": "choice_1", "id": "choice_1_id" }, { "style": "secondary", "text": "choice_2", "id": "choice_2_id" } ], "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": "in_progress", "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", "software": null, "status": "online"}