The API allows a POS to accept Embedded Payments payments.
Embedded Payments API (1.0)
Overview
Languages
Servers
Production
https://api.tyro.com/connect
Request
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.
Security
JWT
- Productionhttps://api.tyro.com/connect/tap-to-pay/merchants/{merchantId}/readers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.tyro.com/connect/tap-to-pay/merchants/98765/readers?locationId=tc-exampleshop-3000' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "results": [ { … } ] }
Request
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.
Security
JWT
The name or description used to identify the reader
Example: "Reader 1 - Example Shop Sydney"
- Productionhttps://api.tyro.com/connect/tap-to-pay/merchants/{merchantId}/readers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.tyro.com/connect/tap-to-pay/merchants/98765/readers \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Reader 1 - Example Shop Sydney",
"locationId": "tc-exampleshop-3000"
}'Request
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
Security
JWT
- Productionhttps://api.tyro.com/connect/tap-to-pay/merchants/{merchantId}/readers/{readerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.tyro.com/connect/tap-to-pay/merchants/98765/readers/0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Reader
The ID of the reader as specified by the Tyro Connect system. This value will be required when creating an Embedded Payments connection.
Example: "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149"
The ID of the location as specified by the Tyro Connect system
Example: "tc-exampleshop-3000"
The name of the reader, a readable identifier for the reader.
Example: "Reader 1 - Example Shop Sydney"
Response
application/json
{ "readerId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149", "locationId": "tc-exampleshop-3000", "name": "Reader 1 - Example Shop Sydney", "status": "ACTIVE", "caid": "string" }