Bead Developers
  • Introduction
  • Quick Start
  • Authentication
  • Payments
    • Create Payment
    • Payment Statuses
    • Payment Webhooks
    • Test Transactions - Crypto
    • Changelog
  • Entity Management
    • Onboarding
    • Merchant Management
      • Get Merchant
      • Changelog
    • Location Management
      • Create Location
      • Get Location
      • List Locations
      • Update Location
      • Delete Location
      • Changelog
    • Terminal Management
      • Terminal Lifecycle (Concepts)
      • Create Terminal
      • Get Terminal
      • List Terminals
      • Update Terminal
      • Delete Terminal
      • Webhook Management
      • Changelog
  • Settlement
    • Batches
    • Settlement Details
  • Reporting
    • Payment History Concepts
      • Pagination and Sorting
    • Partner Payments
    • Merchant Payments
    • Terminal Payments
    • Changelog
  • Reference Guide
    • Core Concepts
      • Environments & Base URLs
      • Authentication
      • Error Codes
    • Enumerations & Schemas
      • Tender Types
        • Crypto
        • Alternative Payments
      • Settlement Currencies
      • Common Field Types
    • Endpoint Index
      • Table View (All APIs)
      • Download OpenAPI / Postman
    • Payment Scenarios
      • Under- and Over-Payment Handling
      • Reclaiming Unconverted Crypto
    • Operational Guides
      • Compatible Crypto Wallets
      • Webhook Event Reference
    • Support & Contacts
      • Integration Support
      • Escalation Contacts
    • Changelog
  • FAQs & Troubleshooting
    • Authentication FAQs
    • Payments FAQs
      • Resolving “403 Forbidden” When Creating Payments
    • Environment & Testing
      • How to Test Klarna Payments
      • How to Prepare for USDC Testing
      • How to Test Klarna Payments
    • Webhooks & Error Codes
Powered by GitBook
On this page
  • Endpoint
  • Path parameters
  • Request headers
  • Successful response
  • Error responses
  • Best practices
  • Related endpoints
  1. Entity Management
  2. Location Management

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

Related endpoints

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

  • Get Location – GET /Locations/{id} to verify no child terminals remain

  • Delete Terminal – DELETE /Terminals/{id} for each device under the location

PreviousUpdate LocationNextChangelog

Last updated 10 days ago