The Reader object

Attributes

  • idstring

    Unique identifier for the object.

  • device_typeenum

    Type of reader, one of bbpos_wisepad3, stripe_m2, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader.

    Possible enum values
    bbpos_chipper2x
    bbpos_wisepad3
    bbpos_wisepos_e
    mobile_phone_reader
    simulated_wisepos_e
    stripe_m2
    verifone_P400
  • labelstring

    Custom label given to the reader for easier identification.

  • locationnullable stringExpandable

    The location identifier of the reader.

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

  • serial_numberstring

    Serial number of the reader.

  • statusnullable enum

    The networking status of the reader.

    Possible enum values
    offline
    online

More attributes

  • objectstring

  • actionnullable object

  • device_sw_versionnullable string

  • ip_addressnullable string

  • last_seen_atnullable integerPreview feature

  • livemodeboolean

The Reader object
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": null,
"device_sw_version": "",
"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"
}

Create a Reader

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.

  • 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 a Reader object if creation succeeds.

POST /v1/terminal/readers
curl https://api.stripe.com/v1/terminal/readers \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d label="Blue Rabbit" \
-d registration_code=simulated-wpe \
-d location=tml_FDOtHwxAAdIJOh
Response
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": null,
"device_sw_version": "",
"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"
}

Update a Reader

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.

  • 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 object if a valid identifier was provided.

POST /v1/terminal/readers/:id
curl https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7 \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d "metadata[order_id]"=6735
Response
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": null,
"device_sw_version": "",
"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"
}

Retrieve a Reader

Retrieves a Reader object.

Parameters

No parameters.

Returns

Returns a Reader object if a valid identifier was provided.

GET /v1/terminal/readers/:id
curl https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7 \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": null,
"device_sw_version": "",
"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"
}

List all Readers

Returns a list of Reader objects.

Parameters

  • device_typeenum

    Filters readers by device type

  • locationstring

    A location ID to filter the response list to only readers at the specific location

  • serial_numberstring

    Filters readers by serial number

  • statusenum

    A status filter to filter readers to only offline or online readers

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit readers, starting after reader starting_after. Each entry in the array is a separate Terminal Reader object. If no more readers are available, the resulting array will be empty.

GET /v1/terminal/readers
curl -G https://api.stripe.com/v1/terminal/readers \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d limit=3
Response
{
"object": "list",
"url": "/v1/terminal/readers",
"has_more": false,
"data": [
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": null,
"device_sw_version": "",
"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"
}
{...}
{...}
],
}
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$