Get Location

Retrieves the full details of a single location, including address, tender-type settings, and current metadata.

Endpoint

GET /Locations/{id}

Path parameters

Name	Type	Required	Description
id	string	✔︎	The locationId returned when the location was created

Request headers

Header	Value
Authorization	Bearer <access-token>
Accept	application/json

Example request

curl -X GET "https://api.test.devs.beadpay.io/Locations/loc_bfdc6a7f" \
     -H "Authorization: Bearer $TOKEN"

Successful response — 200

{
  "id": "loc_bfdc6a7f",
  "created": "2025-06-04T16:08:03.226Z",
  "updated": "2025-06-04T16:08:03.226Z",
  "merchantId": "mer_4e5a13aa",
  "name": "Downtown Flagship",
  "tenderTypes": ["ethereum"],
  "maxTransactionAmount": 1000000,
  "address": {
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Springfield",
    "region": "MA",
    "country": "US",
    "postalCode": "01109"
  },
  "terminals": [
    {
      "terminalId": "term_123",
      "name": "Front Counter 1",
      "isEnabled": true,
      "created": "2025-06-05T10:12:44.001Z"
    }
  ]
}

Field	Description
id	The unique locationId
created, updated	ISO-8601 timestamps (UTC)
merchantId	Parent merchant
name	Friendly display name
tenderTypes	Enabled rails (inherits from merchant if empty)
maxTransactionAmount	Hard ceiling in minor units (0 = no limit)
address.*	Full postal address object
terminals	Array of brief terminal summaries under this location

Error responses

Code	Condition
404	Location {id} does not exist or is not visible to your token

Best practices

• Cache the response client-side to avoid redundant calls when rendering dashboards

• Use the updated timestamp to determine if you need to refresh local copies

• If terminals grows large, call GET /Locations/{id}/terminals for paginated results |

Related endpoints

• Update Location – PUT /Locations/{id} to modify fields

• Delete Location – DELETE /Locations/{id} when decommissioning a store

• List Locations – GET /Merchants/{id}/locations for a collection view