Create Store

A store is created using a store name, with additional optional details such as email, phone number, and address. You can also configure custom fields and tip settings as part of the store setup.

Body Params
string
required

Enter the store name you want to create. It identifies the store across your terminals and payment activity and should be distinct from other stores in your account.

string

Provide an email address for the store. This is optional and can be used for store-specific communication, notifications, or record-keeping if needed.

string

Select the currency you want this store to operate in. All terminals and terminal charges under this store will automatically use this default currency.

string

Specify the country calling code associated with the store’s phone number.

string

Add a phone number for the store. This is optional and can be used for verification, support communication, or internal reference.

address
object

Provide the store’s physical or operating address. While optional, this helps you maintain organized records and adds more context to the store’s profile.

custom_fields
object

Use this field to add any additional information you want to store, such as identifiers, tags, or notes. Custom fields help you tailor the store setup to specific business needs.

tip
object

Set whether tipping should be available for terminals under this store. This allows you to offer customers an optional tip during the checkout flow, based on your preference.

Response

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Questions? Contact us