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

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"
    }
    {...}
    {...}
  ],
}

Delete a Reader

Deletes a Reader object.

Parameters

No parameters.

Returns

Returns the Reader object that was deleted.

DELETE /v1/terminal/readers/:id
curl -X DELETE https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7 \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
  "id": "tmr_FDOt2wlRZEdpd7",
  "object": "terminal.reader",
  "deleted": true
}

Cancel the current reader action

Cancels the current reader action.

Parameters

No parameters.

Returns

Returns an updated Reader resource.

POST /v1/terminal/readers/:id/cancel_action
curl -X POST https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7/cancel_action \
  -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": 1695402450407,
  "livemode": false,
  "location": "tml_FDOtHwxAAdIJOh",
  "metadata": {},
  "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7",
  "status": "online"
}

Collect inputs using a ReaderPreview feature

Initiates an input collection flow on a Reader.

Parameters

  • inputsarray of objectsRequired

    List of inputs to be collected using 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 resource.

POST /v1/terminal/readers/:id/collect_inputs
cURL
curl https://api.stripe.com/v1/terminal/readers/tmr_OXYJvwsea7PDiDHNciXRkytb/collect_inputs \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d "inputs[0][type]"=signature \
  -d "inputs[0][custom_text][title]"=Signature \
  -d "inputs[0][custom_text][description]"="Please sign below" \
  -d "inputs[0][custom_text][submit_button]"=Submit \
  -d "inputs[0][custom_text][skip_button]"=Skip \
  -d "inputs[0][required]"=false \
  -d "inputs[1][type]"=selection \
  -d "inputs[1][custom_text][title]"=Selection \
  -d "inputs[1][custom_text][description]"="Please select one" \
  -d "inputs[1][required]"=true \
  -d "inputs[1][selection][choices][0][style]"=primary \
  -d "inputs[1][selection][choices][0][value]"=choice_1 \
  -d "inputs[1][selection][choices][1][style]"=secondary \
  -d "inputs[1][selection][choices][1][value]"=choice_2 \
  -d "inputs[2][type]"=email \
  -d "inputs[2][custom_text][title]"="Enter your email" \
  --data-urlencode "inputs[2][custom_text][description]"="We'll send updates on your order and occasional deals" \
  -d "inputs[2][custom_text][submit_button]"=Submit \
  -d "inputs[2][custom_text][skip_button]"=Skip \
  -d "inputs[2][required]"=false
Response
{
  "id": "tmr_OXYJvwsea7PDiDHNciXRkytb",
  "object": "terminal.reader",
  "action": {
    "failure_code": null,
    "failure_message": null,
    "collect_inputs": {
      "inputs": [
        {
          "type": "signature",
          "custom_text": {
            "title": "Signature",
            "description": "Please sign below",
            "submit_button": "Submit",
            "skip_button": "Skip"
          },
          "required": false,
          "value": null
        },
        {
          "type": "selection",
          "custom_text": {
            "title": "Selection",
            "description": "Please select one"
          },
          "required": true,
          "selection": {
            "choices": [
              {
                "style": "primary",
                "value": "choice_1"
              },
              {
                "style": "secondary",
                "value": "choice_2"
              }
            ],
            "value": null
          }
        },
        {
          "type": "email",
          "custom_text": {
            "title": "Enter your email",
            "description": "We'll send updates on your order and occasional deals",
            "submit_button": "Submit",
            "skip_button": "Skip"
          },
          "required": false,
          "value": null
        }
      ]
    },
    "status": "in_progress",
    "type": "collect_inputs"
  },
  "device_deploy_group": null,
  "device_sw_version": null,
  "device_type": "bbpos_wisepos_e",
  "ip_address": "192.168.2.2",
  "label": "Blue Rabbit",
  "livemode": false,
  "location": null,
  "metadata": {},
  "serial_number": "123-456-789",
  "software": null,
  "status": "online"
}

Confirm a PaymentIntent on the ReaderPreview feature

Finalizes a payment on a Reader.

Parameters

  • payment_intentstringRequired

    PaymentIntent ID

Returns

Returns an updated Reader resource.

POST /v1/terminal/readers/:id/confirm_payment_intent
cURL
curl https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7/confirm_payment_intent \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d payment_intent=pi_1NrpbFBHO5VeT9SUiCEDMdc8
Response
{
  "id": "tmr_FDOt2wlRZEdpd7",
  "object": "terminal.reader",
  "action": {
    "failure_code": null,
    "failure_message": null,
    "collect_payment_method": {
      "payment_intent": "pi_1NrpbFBHO5VeT9SUiCEDMdc8"
    },
    "status": "in_progress",
    "type": "confirm_payment_intent"
  },
  "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.
$