Integrating CityPASS

Follow the steps in the sections below to learn how to enable and configure your integration, map your CityPASS attractions, and scan, validate, and redeem passes.

Before you begin

To get started with FareHarbor’s CityPASS integration, ensure that you have:

• Administrator or Director permissions in your Dashboard
• A CityPASS account and valid credentials
• Barcode scanner or device that can read QR codes
• Affiliate setup

To use FareHarbor’s CityPASS integration, ensure that you are set up as an affiliate. If you are not currently configured as an affiliate, fill out the New Affiliate Request form.

If you don’t see the integration in your Dashboard after you are set up as an affiliate, contact your Account Manager or FareHarbor Support.

Hardware requirements

Use a handheld barcode reader to check in your customers by scanning the QR codes generated from their bookings.

To enable the CityPASS integration on your FareHarbor Dashboard:

1. Click Settings in your FareHarbor Dashboard.
2. Go to the advanced company settings by clicking the cog icon.
3. Navigate to the Integrations section and check the CityPASS integration box.
4. Click Save changes.

Once you have enabled the FareHarbor CityPASS integration, you may begin configuring your integration on your FareHarbor Dashboard. To begin configuring your integration, create custom fields for CityPASS passes.

Configuring custom fields for the CityPASS integration

To create a custom field for CityPASS passes:

1. Go to Settings and click + New custom field.
2. Choose Pass: CityPASS from the Field type dropdown
3. Fill in the Internal name, Title, and Description fields.
4. Click Create custom field.

Connecting custom fields to a customer type

After you create a custom field for CityPASS passes, you may connect the custom field to a customer type. Add a CityPASS custom field to a customer type only for items that you are offering with CityPASS.

To connect the custom field to a customer type:

1. Go to the Customer Type and click + Add custom field. Connect this custom field only when CityPASS is selected as the affiliate.
2. Add the CityPASS field into the Customer Type.
3. Click Add at the bottom of the custom field section of your Customer Type.

Authorizing your CityPASS and FareHarbor account

1. Go to Settings in your Dashboard navigation.
2. Click Integrations.
3. Select the CityPASS tab.
4. Enter your CityPASS credentials with your username and password.
5. Click Save Credentials.

Once you have set up your custom fields and customer types and authorized your integration, you may begin mapping your FareHarbor items to your CityPASS attractions.

To map your items:

1. Under Map CityPASS Credentials, select FareHarbor items you’d like to map.
2. Fill in the corresponding CityPASS username and CityPASS password across from the relevant FareHarbor item.
3. Click Save Mappings.

To scan and validate CityPASS passes for walk-up bookings:

1. In your FareHarbor Dashboard, create a manual booking for the selected availability.
2. Scan the customer’s CityPASS QR code.
3. Validate all passes by clicking the Validate button next to each CityPASS custom field.
4. When all passes are successfully validated, you may then conclude the process by clicking Complete booking. This is only possible once all validations are successful.

Once a CityPASS pass has been scanned and validated, the pass can be redeemed.

To redeem a CityPASS pass:

1. After completing a booking with a CityPASS pass, navigate to the Manifest in your FareHarbor Dashboard. This should be done at the time of the availability when the customer has already arrived.
2. Click the relevant booking.
3. In the booking overlay, click the dropdown under the customer type to change the status from Not checked in to Checked in.

Once the customer is successfully checked-in, they can enter the attraction. Checking in your customers will ensure that the booking is captured on your CityPASS invoicing report. Alternatively, you may check the customer in on the booking form.

The scan failed. What should I do?

Check that the code is a valid CityPASS QR code. If issues persist, contact FareHarbor Support.

The feature is missing from my Dashboard. Why?

It may not be enabled yet. Contact your Account Manager or FareHarbor Support.