Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Create a Location

Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

post/v1/terminal/locations

Response

Successful response.

configuration_overridesstring

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

display_namestring required

The display name of the location.

display_name_kanastring

The Kana variation of the display name of the location.

display_name_kanjistring

The Kanji variation of the display name of the location.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'terminal.location' required

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

phonestring

The phone number of the location.