For the complete documentation index, see llms.txt. This page is also available as Markdown.

Delete Location

Permanently removes a location and its metadata from Bead. Deletion succeeds only when the location has no terminals.

Endpoint

DELETE /Locations/{id}

Path parameters

Name
Type
Required
Description

id

string

Yes

The locationId you intend to delete

Request headers

Header
Value

X-Api-Key

{adminApiKey}

Accept

application/json

Example request

curl -X DELETE "https://api.test.devs.beadpay.io/Locations/{locationId}" \
     -H "X-Api-Key: {adminApiKey}"

Successful response

204 No Content — no response body is returned.

Before you delete

Before deleting a location, disable it with PUT /Locations/{id}/enabled to stop new payment activity while preserving history. Delete only once you have confirmed no active terminals remain.

If you may need the location again later, disabling is the better option — the record and its history cannot be retrieved after deletion.

Error responses

Code
Condition

400

Invalid request or business rule violation — common cause is attempting to delete a location that still has terminals

401

Missing or invalid API key

403

Not permitted to delete this location

404

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

Best practices

  • Disable every terminal under the location before attempting deletion.

  • Use GET /Locations/{id} to confirm the terminals array is empty before calling delete.

  • Archive the location details in your own system first — the record cannot be retrieved after deletion.

  • Perform deletes during low-traffic windows to reduce the risk of concurrent provisioning.

Last updated