Connect to a reader

Connect your application to a Stripe Terminal reader.

If you haven’t chosen a reader yet, compare the available Terminal readers and choose one that best suits your needs.

The server-driven integration is generally available in the United States and Canada. To request access to the server-driven integration in countries other than the US and CA, please email stripe-terminal-betas@stripe.com.

Stripe provides a mechanism to create a simulated server-driven reader, so you can develop and test your app without connecting to physical hardware. Whether you’re just starting out or your integration is complete, use the simulated reader to emulate Terminal payments in your app.

Create a simulated reader

In order to create a simulated reader use the designated registration code (simulated-wpe) when registering the reader. This registration code creates a simulated WisePOS E reader object in test mode only. You can register the simulated reader using the Stripe API:

Command Line

curl https://api.stripe.com/v1/terminal/readers \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d location={{LOCATION_ID}} \
  -d registration_code=simulated-wpe

This returns a reader object representing your simulated reader:

{
  "id": "tmr_xxx",
  "object": "terminal.reader",
  "device_sw_version": "",
  "device_type": "simulated_wisepos_e",
  "ip_address": "0.0.0.0",
  "label": "simulated-wpe-xxx-xxx-xx-xxx",
  "livemode": false,
  "location": "tml_xxx",
  "serial_number": "simulated-wpe-xxx-xxx-xx-xxx",
  "status": "online"
}

Query your simulated reader

The simulated reader behaves like a real reader – if you need, you can retrieve its information from the reader endpoint:

Command Line

curl https://api.stripe.com/v1/terminal/readers/tmr_xxx \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:

{
  "id": "tmr_xxx",
  "object": "terminal.reader",
  "action": null,
  "device_sw_version": "",
  "device_type": "simulated_wisepos_e",
  "ip_address": "0.0.0.0",
  "label": "simulated-wpe-xxx-xxx-xx-xxx",
  "livemode": false,
  "location": "tml_xxx",
  "metadata": {
  },
  "serial_number": "simulated-wpe-xxx-xxx-xx-xxx",
  "status": "offline"
}

Next steps

You’ve connected your application to the reader. Next, collect your first Stripe Terminal payment.

Collect payments

The BBPOS and Chipper™ name and logo are trademarks or registered trademarks of BBPOS Limited in the United States and/or other countries. The Verifone® name and logo are either trademarks or registered trademarks of Verifone in the United States and/or other countries. Use of the trademarks does not imply any endorsement by BBPOS or Verifone.