Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Reader 

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Endpoints

The Reader object 

Attributes

  • idstring

    Unique identifier for the object.

  • device_typeenum

    Device type of the reader.

    Possible enum values
    bbpos_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_wisepos_e

    Simulated BBPOS WisePOS E reader.

    stripe_m2

    Stripe M2 reader.

    stripe_s700

    Stripe S700 reader.

  • 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. We do not recommend using this field in flows that may block taking payments.

    Possible enum values
    offline
    online

More attributes

  • objectstring

  • actionnullable object

  • device_sw_versionnullable string

  • ip_addressnullable string

  • last_seen_atnullable timestamp

  • 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_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -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_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -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_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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"
}