Attributes
- idstring
Unique identifier for the object.
- device_
typeenum Device type of the reader.
Possible enum valuesbbpos_chipper2x BBPOS Chipper 2X BT reader.
bbpos_wisepad3 BBPOS WisePad 3 reader.
bbpos_wisepos_ e BBPOS WisePOS E reader.
mobile_phone_ reader Tap to Pay device.
simulated_stripe_ s700 Simulated Stripe S700 reader.
simulated_stripe_ s710 Simulated Stripe S710 reader.
simulated_verifone_ m425 Simulated Verifone M425 reader.
simulated_verifone_ p630 Simulated Verifone P630 reader.
simulated_verifone_ ux700 Simulated Verifone UX700 reader.
simulated_verifone_ v660p Simulated Verifone V660p reader.
Show 8 more - labelstring
Custom label given to the reader for easier identification.
- locationnullable stringExpandable
The location identifier of the reader.
- metadatamap
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.
- serial_
numberstring Serial number of the reader.
- statusnullable enum
The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
Possible enum valuesofflineonline
More attributes
- objectstring
- actionnullable object
- device_
sw_ versionnullable string - ip_
addressnullable string - last_
seen_ atnullable timestamp - livemodeboolean
{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}Creates a new Reader object.
Parameters
- registration_
codestringRequired A code generated by the reader used for registering to an account.
- labelstring
Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
- locationstringRequired
The location to assign the reader to.
- metadatamap
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 a Reader object if creation succeeds.
curl https://api.stripe.com/v1/terminal/readers \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d "label=Blue Rabbit" \ -d registration_code=simulated-wpe \ -d location={{LOCATION_ID}}{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- labelstring
The new label of the reader.
- metadatamap
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 object if a valid identifier was provided.
curl https://api.stripe.com/v1/terminal/readers/{{READER_ID}} \ -u "sk_test_Hrs6SAopgFPF0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:" \ -d "metadata[order_id]=6735"{ "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "2.37.2.0", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": { "order_id": "6735" }, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online"}