POST /v1/terminal/readers/{reader}/collect_inputs
Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
reader |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
inputs[] |
Array | Yes |
List of inputs to be collected from the customer using the Reader. Maximum 5 inputs. |
inputs[].required |
Boolean | No | |
inputs[].selection |
Object | No | |
inputs[].selection.choices[] |
Array | Yes | |
inputs[].selection.choices[].id |
String | Yes | |
inputs[].selection.choices[].text |
String | Yes | |
inputs[].selection.choices[].style |
String | No |
Valid values:
|
inputs[].type |
String | Yes |
Valid values:
|
inputs[].custom_text |
Object | Yes | |
inputs[].custom_text.skip_button |
String | No | |
inputs[].custom_text.description |
String | No | |
inputs[].custom_text.submit_button |
String | No | |
inputs[].custom_text.title |
String | Yes | |
inputs[].toggles[] |
Array | No | |
inputs[].toggles[].default_value |
String | No |
Valid values:
|
inputs[].toggles[].description |
String | No | |
inputs[].toggles[].title |
String | No | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
Object | No |
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 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.