docs
Get startedTroubleshootingPaymentsWebhooksAgent paymentsSwop MCPOviIdentity (swop.id)SwivyRPC (preview)API reference

Locations

Read your physical locations and the tap-to-pay terminals at each one.

A location is a physical place you sell from, such as a shop or a market stall: a named point on the map with a radius. Locations anchor your in-person checkout terminals and your drops. Create and edit them in the Swop app; the API reads them.

List locations

GEThttps://apps.apiswop.co/api/v5/merchant/locations

Scope: drops.read

Returns your locations that aren't archived, oldest first.

curl https://apps.apiswop.co/api/v5/merchant/locations \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"

Response

{
  "success": true,
  "data": [
    {
      "locationId": "6701a2b3c4d5e6f7a8b9c0d1",
      "merchantId": "65f0c1a2b3c4d5e6f7a8b9c0",
      "micrositeId": null,
      "name": "Ember Coffee, Main St",
      "address": "12 Main St, Austin, TX",
      "location": { "lat": 30.2672, "lng": -97.7431 },
      "radiusMeters": 75,
      "status": "active",
      "viewerIsMerchant": true,
      "createdAt": "2026-09-16T10:00:00.000Z",
      "updatedAt": "2026-09-16T10:00:00.000Z"
    }
  ]
}
FieldMeaning
locationIdThe location's ID
name, addressAs set in the app
locationThe map pin
radiusMetersHow close someone must be, 10 to 5,000 metres (default 75)
statusactive or hidden (archived locations aren't listed)
micrositeIdThe SmartSite linked to this location, if any

Retrieve a location

GEThttps://apps.apiswop.co/api/v5/merchant/locations/{id}

Scope: drops.read

Returns one location in the same shape, under data. 404 if it doesn't exist (or isn't yours and isn't active).

curl https://apps.apiswop.co/api/v5/merchant/locations/6701a2b3c4d5e6f7a8b9c0d1 \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"

List terminals

GEThttps://apps.apiswop.co/api/v5/merchant/locations/{id}/terminals

Scope: drops.read

A terminal is a tap-to-pay point at a location, such as an NFC tag on the counter that opens checkout when a phone taps it.

curl https://apps.apiswop.co/api/v5/merchant/locations/6701a2b3c4d5e6f7a8b9c0d1/terminals \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"
Response
{
  "success": true,
  "data": [
    { "terminalId": "…", "label": "Front counter", "status": "active", "programmed": true }
  ]
}
FieldMeaning
terminalIdThe terminal's ID
labelYour name for it
statusactive or disabled
programmedWhether a physical NFC tag has been written for it

On this page