Create a Reader

An async endpoint used for creating a Reader. Register a webhook to be notified when a Reader is created after this endpoint is invoked. 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 creating the reader

Example: 98765

header Parameters

Authorization required	string Default: Bearer {$$.env.access_token}
Content-Type required	string Value: "application/json"

Request Body schema: application/json

name required	string The name or description used to identify the reader
locationId required	string The Tyro Connect Location ID

Responses

202

Accepted

400

When the provided payload is not valid.

403

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

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

Request samples

Payload
curl
C#
Node.js

application/json

{"name": "Reader 1 - Example Shop Sydney",
"locationId": "tc-exampleshop-3000"
}

Response samples

application/json

{"error": "\"locationId\" is required",
"errorCode": "VALIDATION_ERROR"
}