Create Embedded Payments connection

When your App is first initialised, a request is sent to your server to establish a Tyro Embedded Payments connection. This is required to connect to the Embedded Payments reader. Upon receiving the client request, authenticate your user and send the request to Tyro with the readerId in the request body.

Request

Security:

JWT

header Parameters

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

Request Body schema: application/json

readerId

required

string

The ID of the reader to be used to establish the connection.

Responses

201

Created

400

When the provided payload is not valid.

403

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

404

When the provided readerId does not exist in our system.

post/tap-to-pay/connections

Request samples

Payload
curl
C#
Node.js

application/json

{"readerId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149"
}

Response samples

application/json

{"id": "2688fcf2-44dd-4c72-88ac-79d0910f2983",
"connectionSecret": "$2a$10$OjXTE/Ul4UVVlW8RtKNtcuV3NdoP8sFc.5Lqov0N5wp6vU8Dmj8H3",
"createdDate": "2023-05-02T08:28:13+10:00",
"readerId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"readerName": "Reader 1 - Example Shop Sydney",
"locationId": "tc-exampleshop-3000",
"locationName": "Example Shop Melbourne"
}