Collect on-screen inputs

You can collect customer information even when the smart reader is operating offline.

To collect inputs using Terminal’s smart readers, call collectInputs with the Terminal SDK, the SDK communicates with the reader to display a prebuilt UI. You can specify up to 5 inputs at a time, and the reader collects them in sequence. After the customer inputs their data, the SDK returns the collected data with a callback.

let signatureInput = try SignatureInputBuilder(title: "Please sign")
    .setStripeDescription("Please sign if you agree to the terms and conditions")
    .setSkipButtonText("skip form")
    .setSubmitButtonText("Submit signature")
    .build()


let firstSelectionButton = try SelectionButtonBuilder(style: .primary, text: "Yes", id: "yes_id")
    .build()

let secondSelectionButton = try SelectionButtonBuilder(style: .secondary, text: "No", id: "no_id")
    .build()

let firstToggle = try ToggleBuilder(defaultValue: .enabled)
    .setTitle("Sign up for promotional emails")
    .build()

let selectionInput = try SelectionInputBuilder(title: "Choose an option")
    .setStripeDescription("Were you happy with our customer service?")
    .setRequired(true)
    .setSelectionButtons([firstSelectionButton, secondSelectionButton])
    .setToggles([firstToggle])
    .build()

let collectInputsParams = try CollectInputsParametersBuilder(
    inputs: [signatureInput, selectionInput]
).build()

let cancelable = Terminal.shared.collectInputs(collectInputsParams) { (collectInputsResult, error) in
    if let error = error {
        // Placeholder for handling error
    } else if let result = collectInputsResult {
        // Placeholder for handling collected inputs
    }
}

Customization

You can customize the appearance and behavior of all input types:

• Set important inputs as required to ensure they’re collected. For required inputs, the Skip button is hidden.
• Provide context to your customer by specifying the text you want to display on the reader screen for each input using title and description.

• Use line breaks \n in your text for better formatting.
• Add up to 4 toggles that customers can enable or disable for Boolean options, agreements, or opt-ins.

Email and selection form with toggle

• For selection type inputs, you can emphasize or de-emphasize choices using the style parameter.

Primary and secondary selection choice styles.

When the reader begins collecting inputs, it displays the first input from the list.

After the customer has completed all the inputs, the reader changes to a transitional state for 3 seconds, waiting for a subsequent request. If there is no subsequent request after 3 seconds, the reader changes back to the splash screen.

When all inputs have been collected or skipped, the Terminal SDK returns the collected data.

• For signature type inputs, the returned data is a string in SVG format.
• For selection type inputs, the returned data are the selected button’s text and id fields.
• For phone, email, text, and numeric inputs, the returned data is the string of the customer’s response.
• If an optional input is skipped by the customer, the skipped Boolean is set to true.
• For each toggle, enabled, disabled or skipped is returned corresponding to the index of the input toggles list.

The Terminal SDK returns an error in the event of a canceled action, timed out collection, or other error.