Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Collect inputs using a Reader 

Terminal
Reader
Collect inputs using a Reader

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

Parameters

  • inputsarray of objectsRequired

    List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.

    • 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.skip_buttonstring

        Custom text for the skip button. Maximum 14 characters.

      • inputs.custom_text.submit_buttonstring

        Custom text for the submit button. Maximum 30 characters.

    • inputs.typeenumRequired

      The type of input to collect

      Possible enum values
      email

      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. Can be primary or secondary.

    • 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. Can be enabled or disabled.

      • inputs.toggles.descriptionstring

        The description which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided.

      • inputs.toggles.titlestring

        The title which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided.

  • 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.

POST /v1/terminal/readers/:id/collect_inputs
curl https://api.stripe.com/v1/terminal/readers/tmr_OXYJvwsea7PDiDHNciXRkytb/collect_inputs \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "inputs[0][type]"=signature \
  -d "inputs[0][custom_text][title]"=Signature \
  -d "inputs[0][custom_text][description]"="Please sign below" \
  -d "inputs[0][custom_text][submit_button]"=Submit \
  -d "inputs[0][custom_text][skip_button]"=Skip \
  -d "inputs[0][required]"=false \
  -d "inputs[1][type]"=selection \
  -d "inputs[1][custom_text][title]"=Selection \
  -d "inputs[1][custom_text][description]"="Please select one" \
  -d "inputs[1][required]"=true \
  -d "inputs[1][selection][choices][0][style]"=primary \
  -d "inputs[1][selection][choices][0][text]"=choice_1 \
  -d "inputs[1][selection][choices][0][id]"=choice_1_id \
  -d "inputs[1][selection][choices][1][style]"=secondary \
  -d "inputs[1][selection][choices][1][text]"=choice_2 \
  -d "inputs[1][selection][choices][1][id]"=choice_2_id \
  -d "inputs[2][type]"=email \
  -d "inputs[2][custom_text][title]"="Enter your email" \
  --data-urlencode "inputs[2][custom_text][description]"="We'll send updates on your order and occasional deals" \
  -d "inputs[2][custom_text][submit_button]"=Submit \
  -d "inputs[2][custom_text][skip_button]"=Skip \
  -d "inputs[2][required]"=false
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"
}