POST /v1/terminal/locations
Creates a new Location object.
For further details, including which address fields are required in each country, see the Manage locations guide.
Servers
- https://api.stripe.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
configuration_overrides |
String | No |
The ID of a configuration that will be used to customize all readers in this location. |
address_kanji |
Object | No |
The Kanji variation of the full address of the location (Japan only). |
address_kanji.line2 |
String | No | |
address_kanji.line1 |
String | No | |
address_kanji.town |
String | No | |
address_kanji.postal_code |
String | No | |
address_kanji.country |
String | No | |
address_kanji.state |
String | No | |
address_kanji.city |
String | No | |
address_kana |
Object | No |
The Kana variation of the full address of the location (Japan only). |
address_kana.line2 |
String | No | |
address_kana.line1 |
String | No | |
address_kana.town |
String | No | |
address_kana.postal_code |
String | No | |
address_kana.country |
String | No | |
address_kana.state |
String | No | |
address_kana.city |
String | No | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
phone |
String | No |
The phone number for the location. |
display_name |
String | No |
A name for the location. Maximum length is 1000 characters. |
metadata |
No |
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
display_name_kana |
String | No |
The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters. |
display_name_kanji |
String | No |
The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters. |
address |
Object | No |
The full address of the location. |
address.line2 |
String | No | |
address.line1 |
String | No | |
address.postal_code |
String | No | |
address.country |
String | Yes | |
address.state |
String | No | |
address.city |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.