provider GET /v1/terminal/readers
@utdk/stripe /v1/terminal/readers
List all Readers
<p>Returns a list of <code>Reader</code> objects.</p>
device_type query
Filters readers by device type
enum: bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader…
ending_before query
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
string
expand query
Specifies which fields in the response should be expanded.
array
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
location query
A location ID to filter the response list to only readers at the specific location
string
serial_number query
Filters readers by serial number
string
starting_after query
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
string
status query
A status filter to filter readers to only offline or online readers
enum: offline, online

Try it

Authentication
Configure credentials for Stripe API
getterminalreaders
GET/v1/terminal/readers
<p>Returns a list of <code>Reader</code> objects.</p>

Filters readers by device type

A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

Specifies which fields in the response should be expanded.

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

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

Filters readers by serial number

A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getterminalreaders()