Creating a Square integration

Before you can set up your Square integration, you must first create a Square account. If you don’t already have a Square account, you can use the relevant link in the Signing up for a Square account by region section of this help page to sign up. Once you’ve signed up for a Square account, gather your Access token and Location ID in the Square dashboard. Use these details to enable the Square integration in the FareHarbor Dashboard.

Collecting your access token and location ID in Square

To gather your access token and location ID:

1. Log into Square.
2. Navigate to the Square Developer site.
3. Select Applications from the navigation.
4. Locate your desired application and click Open or create a new application by clicking the + icon.
5. Once in your application, select Credentials.
6. Copy the Access Token to include in your integration settings later on.
7. Navigate to Locations.
8. Select the correct account.
9. Copy the Location ID to include in your integration settings later on.

Enabling up your Square integration in the FareHarbor Dashboard

Once you have your access token and location ID, you may now enable the Square integration on your FareHarbor Dashboard.

To enable the Square integration:

1. Go to Settings.
2. Click the cog icon in the top right corner of your screen to access your Advanced company settings.
3. Select Integrations from the Advanced company settings menu.
4. Check the Square box.
5. Add your Square API key (access token) and Square Location ID.
6. Click Save changes.

Once your Square integration has been set up, you may begin mapping Square items and variations to customer types and custom fields in FareHarbor. If you have not already created items in Square, follow the Square help page for creating and editing items to learn how to do so.

Items created in Square can map to FareHarbor items in your Dashboard. Within a Square item, you may create variations to correspond to FareHarbor customer types and custom fields. More information on creating and editing item variations can be found on the Create and edit item options and variations Square help page.

Once your item and item variations have been created in the Square dashboard, you may begin mapping these items and variations to customer types and custom fields in the FareHarbor Dashboard.

Mapping customer types

To map a Square item to a customer type in your FareHarbor Dashboard:

1. Navigate to the Items section of your Dashboard and select the item you want to update.
2. Go to the item’s Options & Prices.
3. Click on the customer type you would like to map to a Square item variant or create a new customer type.
4. Click the Square catalog object dropdown.

5. Here you will find all Square item variants. Select the desired variant from the dropdown.

   

6. Once you have selected the variant, click Save.

Mapping custom fields

In addition to customer types, you may also map an item variation to a priced custom field.

To map a Square item to a custom field in your FareHarbor Dashboard:

1. Go to Settings > Custom Fields.
2. Select the relevant custom field.
3. Click the Settings button.
4. Navigate to the Square tab in your custom field’s settings.
5. Click the Square catalog object dropdown.

6. Here you will find all Square item variants. Select the desired variant from the dropdown.

   

7. Once you have selected the variant, click Save.

Mapping custom fields to Square ensures that inventory in Square is accurately updated.

For example, if a client sells wine as an add-on to a train ticket through FareHarbor, this mapping will correctly reflect the remaining stock of wine managed by Square.

Additionally, negatively-priced custom fields can also be mapped to your Square dashboard. When mapped, negatively-priced custom fields will appear as discounts in Square.

After you have successfully mapped customer types and custom fields to Square items, bookings made from FareHarbor will be sent to your Square dashboard. FareHarbor bookings appear as orders in the Square dashboard.

Orders will display an overview of the booking, including the source of the FareHarbor bookings (direct, online, or via the API).

Purchases made through FareHarbor will be reflected in your Square inventory. It is not currently possible to make a pre-purchase check of inventory.

Transactions

Each FareHarbor booking sent to Square will result in a transaction, accessible in the Transactions section of your Square dashboard. More information on viewing and searching transactions can be found on the Square Support Center.

Once a booking is made in FareHarbor and the transaction appears in Square, a customer profile will be generated in your Square dashboard. Customer profiles will appear in your Square customer directory. More information about the Square customer directory can be found on the Square Support Center.

When a booking is cancelled in FareHarbor, the corresponding Square order is cancelled and payments are refunded.

If a customer would like to rebook, the original order linked to the cancelled booking will be refunded. Because Square does not allow a single payment to be linked to multiple orders, a new order will be created in Square to match the new booking in FareHarbor.

When a refund is issued in FareHarbor, refund information will be sent to your Square dashboard to ensure that transaction and booking information remains accurate between the two platforms.

Note: This functionality does not currently extend to cancellations and rebookings.

If you don’t already have a Square account, you may use one the following region-specific partnership links to sign up. When you sign up using the link below, you will receive a credit equivalent to 2,000 in free payment processing, calculated in your local currency.

• Australia
• Canada
• France
• Ireland
• Spain
• United Kingdom
• United States

While the Square integration offers the ability to send bookings, customer info, and inventory data to Square, not all FareHarbor functionality can be mapped to your Square dashboard.

The following FareHarbor features and functionality are not currently supported by the Square integration:

• Promo codes
• Memberships
• Combos
• Gift cards
• Partially paid purchases

Additionally, inventory numbers from Square cannot be sent to FareHarbor. If you have inventory set up in Square for retail items, changes made to your inventory in Square will not appear in the FareHarbor Dashboard.