Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

List all Locations 

Returns a list of Location objects.

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit locations, starting after location starting_after. Each entry in the array is a separate Terminal location object. If no more locations are available, the resulting array will be empty.

GET /v1/terminal/locations
curl -G https://api.stripe.com/v1/terminal/locations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/terminal/locations",
  "has_more": false,
  "data": [
    {
      "id": "tml_FBakXQG8bQk4Mm",
      "object": "terminal.location",
      "address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "1234 Main Street",
        "line2": "",
        "postal_code": "94111",
        "state": "CA"
      },
      "display_name": "My First Store",
      "livemode": false,
      "metadata": {}
    }
  ]
}

Delete a Location 

Deletes a Location object.

Parameters

No parameters.

Returns

Returns the Location object that was deleted.

DELETE /v1/terminal/locations/:id
curl -X DELETE https://api.stripe.com/v1/terminal/locations/tml_FBakXQG8bQk4Mm \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "deleted": true
}

Reader 

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Endpoints

Terminal Hardware Order Preview

A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.

Endpoints

Terminal Hardware Product Preview

A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country it’s shipped to.

TerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.

Endpoints