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

Create a Reader 

Terminal
Reader
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"
}