Initiates an input collection flow on a Reader.
Parameters
- inputsarray of objectsRequired
List of inputs to be collected using the Reader
- inputs.
custom_ textobjectRequired Customize the text which will be displayed while collecting this input
- inputs.
custom_text. titlestringRequired The title which will be displayed when collecting this input
- inputs.
custom_text. descriptionstring The description which will be displayed when collecting this input
- inputs.
custom_text. string The skip button text
- inputs.
custom_text. string The submit button text
- inputs.
typeenumRequired The type of input to collect
Possible enum valuesemail
Collect an email
numeric
Collect a number
phone
Collect a phone number
selection
Collect a selection from one or more choices
signature
Collect a signature
text
Collect text
- inputs.
requiredboolean Indicate that this input is required, disabling the skip button
- inputs.
selectionobject Options for the
selection
input- inputs.
selection. choicesarray of objectsRequired List of choices for the
selection
input- inputs.
selection. choices. idstringRequired The unique identifier for this choice
- inputs.
selection. choices. textstringRequired The text which will be shown on the button for this choice
- inputs.
selection. choices. styleenum The style of the button which will be shown for this choice
- inputs.
togglesarray of objects List of toggles to be displayed and customization for the toggles
- inputs.
toggles. default_ valueenum The default value of the toggle
- inputs.
toggles. descriptionstring The description which will be displayed for the toggle
- inputs.
toggles. titlestring The title which will be displayed for the toggle
- metadataobject
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.
{ "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"}