# Adds forms to Terminal readers to collect user information

## What’s new

Adds the ability for Terminal readers to collect customer information using the [collect_inputs](https://docs.stripe.com/api/terminal/readers/collect_inputs.md?api-version=2025-05-28.basil) endpoint. Also adds the testing endpoints [succeed_input_collection](https://docs.stripe.com/api/terminal/readers/succeed_input_collection.md?api-version=2025-05-28.basil) and [timeout_input_collection](https://docs.stripe.com/api/terminal/readers/timeout_input_collection.md?api-version=2025-05-28.basil), which don’t require a physical Terminal reader.

## Impact

You can now display forms on Terminal readers to collect information from customers, such as signature, selection, email, phone, text, and other numeric values.

See [Collect on-screen inputs](https://docs.stripe.com/terminal/features/collect-inputs.md) to learn more.

## Changes

#### REST API

| Endpoints                                              | Change | Resources                                                             |
| ------------------------------------------------------ | ------ | --------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter        | Change | Resources or endpoints                                                                                            |
| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

| Value            | Change | Enum                                                                                                                        |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.action.type](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action-type) |

#### Ruby

| Methods                                                | Change | Resources                                                              |
| ------------------------------------------------------ | ------ | ---------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [Terminal::Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [Terminal::Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter        | Change | Resources or methods                                                                                                |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal::Reader::Action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

#### Python

| Methods                                                | Change | Resources                                                             |
| ------------------------------------------------------ | ------ | --------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter        | Change | Resources or methods                                                                                              |
| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.Action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

| Value            | Change | Enum                                                                                                                        |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.Action.type](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action-type) |

#### PHP

| Methods                                                | Change | Resources                                                             |
| ------------------------------------------------------ | ------ | --------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Value            | Change | Enum                                                                                                                        |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.action.type](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action-type) |

#### Java

| Methods                                                | Change | Resources                                                             |
| ------------------------------------------------------ | ------ | --------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter       | Change | Resources or methods                                                                                              |
| --------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `collectInputs` | Added  | [terminal.Reader.action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

#### Node.js

| Methods                                                | Change | Resources                                                             |
| ------------------------------------------------------ | ------ | --------------------------------------------------------------------- |
| `collect_inputs`                                       | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `succeed_input_collection`, `timeout_input_collection` | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter        | Change | Resources or methods                                                                                              |
| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

| Value            | Change | Enum                                                                                                                        |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [Terminal.Reader.action.type](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action-type) |

#### Go

| Methods                                            | Change | Resources                                                            |
| -------------------------------------------------- | ------ | -------------------------------------------------------------------- |
| `CollectInputs`                                    | Added  | [TerminalReader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `SucceedInputCollection`, `TimeoutInputCollection` | Added  | [TerminalReader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter       | Change | Resources or methods                                                                                            |
| --------------- | ------ | --------------------------------------------------------------------------------------------------------------- |
| `CollectInputs` | Added  | [TerminalReaderAction](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

| Value            | Change | Enum                                                                                                                      |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| `collect_inputs` | Added  | [TerminalReaderAction.Type](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action-type) |

#### .NET

| Methods                                            | Change | Resources                                                             |
| -------------------------------------------------- | ------ | --------------------------------------------------------------------- |
| `CollectInputs`                                    | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |
| `SucceedInputCollection`, `TimeoutInputCollection` | Added  | [Terminal.Reader](/api/terminal/readers?api-version=2025-05-28.basil) |

| Parameter       | Change | Resources or methods                                                                                              |
| --------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `CollectInputs` | Added  | [Terminal.Reader.Action](/api/terminal/readers/object?api-version=2025-05-28.basil#terminal_reader_object-action) |

## Upgrade

#### REST API

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. If you use an SDK, upgrade to the corresponding SDK version for this API version.
   - If you don’t use an SDK, update your [API requests](https://docs.stripe.com/api/versioning.md) to include `Stripe-Version: 2025-05-28.basil`
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Ruby

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Ruby SDK to [v15.2.0](https://github.com/stripe/stripe-ruby/releases/tag/v15.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Python

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Python SDK to [v12.2.0](https://github.com/stripe/stripe-python/releases/tag/v12.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### PHP

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your PHP SDK to [v17.3.0](https://github.com/stripe/stripe-php/releases/tag/v17.3.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Java

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Java SDK to [v29.2.0](https://github.com/stripe/stripe-java/releases/tag/v29.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Node.js

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Node SDK to [v18.2.0](https://github.com/stripe/stripe-node/releases/tag/v18.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### Go

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your Go SDK to [v82.2.0](https://github.com/stripe/stripe-go/releases/tag/v82.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).

#### .NET

1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench.
1. Upgrade your .NET SDK to [v48.2.0](https://github.com/stripe/stripe-dotnet/releases/tag/v48.2.0)
1. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md).
1. [Test your integration](https://docs.stripe.com/testing.md) against the new version.
1. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md).
1. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours.

Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md).