List Embedded Payments Locations

Retrieve the list of location IDs attached to a Tyro Merchant ID. A location ID represents the physical location from which a payment originates and is required in order to create the Reader

Request

Security:

JWT

path Parameters

merchantId

required

string

The Merchant ID requesting the locations

Example: 98765

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The list of locations for the provided merchant ID

403

When you don't have the right permissions to fetch the locations

404

When the provided merchantId does not exist in our system

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

Request samples

curl
C#
Node.js

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

Response samples

application/json

{"results": [{"locationId": "tc-exampleshop-3000",
"name": "Example Shop Melbourne"
},
{"locationId": "tc-exampleshop-2000",
"name": "Example Shop Sydney"
}
]
}