Delete Location

Completely removes a location and its metadata from Bead once it is no longer in use. You must disable or delete all terminals under the location first; otherwise the call returns 409.

Endpoint

DELETE /Locations/{id}

Path parameters

Name
Type
Required
Description

id

string

✔︎

The locationId you intend to delete

Request headers

Header
Value

Authorization

Bearer <access-token>

Accept

application/json

Example request

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

Successful response

HTTP
Body

204 No Content

The server returns no JSON body when deletion succeeds.

Error responses

Code
Condition

404

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

409

Location still has active or historical terminals; disable or delete them first

Best practices

✔︎ Action
Why

Disable every terminal (PUT /Terminals/{id}isEnabled=false) before attempting deletion

Ensures no new transactions are processed mid-decommission

Fetch GET /Locations/{id} to confirm the terminals array is empty

Prevents 409 loops

Archive location data in your own store (if required) before calling delete

The record is irretrievable once removed

Perform deletes in off-peak hours

Minimises risk of concurrent terminal creation during teardown

  • Update LocationPUT /Locations/{id} (set isEnabled=false prior to delete)

  • Get LocationGET /Locations/{id} to verify no child terminals remain

  • Delete TerminalDELETE /Terminals/{id} for each device under the location

Last updated