Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Collect inputs using a Reader

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

post/v1/terminal/readers/{reader}/collect_inputs

Path parameters

readerstring required

Response

Successful response.

device_sw_versionstring nullable

The current software version of the reader.

device_type'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' | 'mobile_phone_reader' | 'simulated_stripe_s700' | 'simulated_stripe_s710' | 'simulated_verifone_m425' | 'simulated_verifone_p630' | 'simulated_verifone_ux700' | 'simulated_verifone_v660p' | 'simulated_wisepos_e' | 'stripe_m2' | 'stripe_s700' | 'stripe_s710' | 'verifone_P400' | 'verifone_m425' | 'verifone_p630' | 'verifone_ux700' | 'verifone_v660p' required

Device type of the reader.

idstring required

Unique identifier for the object.

ip_addressstring nullable

The local IP address of the reader.

labelstring required

Custom label given to the reader for easier identification.

last_seen_atinteger nullable

The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'terminal.reader' required

String representing the object's type. Objects of the same type share the same value.

serial_numberstring required

Serial number of the reader.

status'offline' | 'online' nullable

The networking status of the reader. We do not recommend using this field in flows that may block taking payments.