List Readers

This endpoint is used for retrieving a list of Readers. Readers represent the Embedded Payments Reader at the physical location. The Reader ID is required to create a Reader Connection to initialise the Tyro Embedded Payments SDK.

Request

Security:

JWT

path Parameters

merchantId

required

string

The Merchant ID associated with the reader

Example: 98765

query Parameters

locationId

string

The Tyro Connect Location Id of the Readers to be retrieved. This parameter is optional.

Example: locationId=tc-exampleshop-3000

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The list Readers

403

When you don't have the right permissions to retrieve the Readers for the provided location or Merchant ID.

get/tap-to-pay/merchants/{merchantId}/readers

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/tap-to-pay/merchants/{merchantId}/readers?locationId=tc-exampleshop-3000' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"results": [{"readerId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"locationId": "tc-exampleshop-3000",
"name": "Reader 1 - Example Shop Sydney",
"status": "ACTIVE"
}
]
}