Get a Reader

This endpoint is used for retrieving a Reader. 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
readerId required	string The Reader ID Example: 0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The requested Reader

403

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

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

Request samples

curl
C#
Node.js

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

Response samples

application/json

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