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

The Location object 

Terminal
Location
The Location object

Attributes

  • idstring

    Unique identifier for the object.

  • addressobject

    The full address of the location.

    • address.citynullable string

      City, district, suburb, town, or village.

    • address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • address.line1nullable string

      Address line 1 (e.g., street, PO Box, or company name).

    • address.line2nullable string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • address.postal_codenullable string

      ZIP or postal code.

    • address.statenullable string

      State, county, province, or region.

  • display_namestring

    The display name of the location.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

More attributes

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • configuration_overridesnullable string

    The ID of a configuration that will be used to customize all readers in this location.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

The Location object
{
  "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": {}
}