FreedomPay - Setup and Configuration June2020

FreedomPay is a payment device integration. It is integrated with Brink POS and can be deployed

separately from Brink POS. We currently have tested our integration with the Lane3000 and Lane7000

payment devices. Additional devices may work but have not been certified with Brink POS.

GETTING STARTED – QUICK LIST

This is a quick list of everything you should ideally have ahead of time to be able to setup FreedomPay

end-to-end.

HARDWARE - Payment Device (Currently we are officially supporting the Lane3000 and Lane7000)

CREDENTIALS Enterprise portal credentials would be managed by the customer’s team after the initial credentials

were setup.

- FreedomPay Enterprise Portal

o Enterprise Code, User Name and Password

- StoreID (called MerchantID in Settings Editor)

- TerminaID

NOTES

- This setup assumes that you are doing the typical installation for FreedomPay where the FCC

client and server are both installed on the same machine the register is installed on.

FREEDOMPAY CONFIGURATION

You will first need to obtain a login from FreedomPay for your enterprise portal. You should have an

Enterprise Code, User Name and Password.

If this setup is for UAT use the following URL:

https://enterprise.uat.freedompay.com/

For production use the following URL:

https://enterprise.freedompay.com/

Once logged in, you must:

1. Navigate “Device Management -> Manage Activation Keys”

2. Click on “Generate”.

3. Copy the “Key” column text and save it for later.

This autogenerated activation key is used to activate every device that will be part of this enterprise. The

same key can be used to activate up to 50,000 devices. Once the key is used to activate a device, it

creates a link between that device and the enterprise which could potentially be used in the future to

push updates to all devices remotely. Contact FreedomPay for additional details.

INSTALLING THE SOFTWARE

FreedomPay has three pieces of software that need to be installed. The "Freeway Commerce Connect" or "FCC" software, FreedomPay Remote Update Service and the drivers for the device that need to be installed.

1. Download the software here → FCC_5.0.0.13.zip 2. Locate the FreewayCommerceConnect.exe inside the DISK1 folder. Right click on the executable

and select “Run as an Administrator.” 3. The first software that is installed is the Remote Update Service. 4. The Device Management Portal Activation URL that is defaulted there is for production. If this is

a setup for UAT you will need to update the URL to the following: 1. https://enterprise-

services.uat.freedompay.com/authorizationserver/auth/activationkeys/ 5. You will need to enter in your Device Management Portal Activation Key obtained from the

FreedomPay Enterprise Portal section above.

6. Once it is installed, it will automatically start the installation of the FCC software. 7. Select “Typical” setup. 8. The FCC Installer will run through the installers for any of the prerequisites that are not already

installed. This includes the ODBC Driver 11 for SQL Server, Express LocalDB SQL Server, SQL Server (Native Client), Command Line Utilities for SQL Server, and .NET 4.6. For each one, accept all default options and accept the License Agreements.

9. Once the installation is complete, you will need to may need to update several settings.

FCC SETTINGS

CONFIGURING THE FCC SERVICES TO POINT TO PRODUCTION

If you are deploying this to production, no other settings need to be modified as the default settings are

already set for production.

CONFIGURING THE FCC SERVICES TO POINT TO UAT

1. Edit the following settings in the config files found in the install directory, C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect

2. In C:\Program Files(86)\FreedomPay\FreewayCommerceConnect\

FreewayClientService.exe.config Update the following keys to have the values below: <add key="freewayUrl" value="https://cs.uat.freedompay.com/Freeway/Service.asmx"/> <add key="cardStorUrl" value="https://cs.uat.freedompay.com/CardStor/CardStorService.asmx"/> FreeWayServerService.exe.config Update the following keys to have the values below: <add key="freewayServer" value="https://cs.uat.freedompay.com/"/>

3. Restart both the FCC Client and Server services for the changes to take effect. 4. Task Manager > Services > Right click on “FCCClientSvc” and “FCCServerSvc” and Restart.

SETUP USB DRIVERS

(Note: these drivers may already be installed by the FCC software above)

1. Plug in the payment device.

2. Go to the windows “Device Manager”, check that the device looks like the following highlighted

device below. The sub-item below will usually be the model of payment device you are using.

3. If it does not look like the device above, follow the following steps:

a. For USB devices supported by the FCC, you will need to install the Freeway MsrLib USB

driver.

b. Navigate to the install directory,

C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect

c. Run FreewayMsrLib-LibUsbDrivers.exe

d. Check the Device Manager again to confirm.

SETTINGS EDITOR SETTINGS

There are two ways that you can configure FreedomPay in the settings editor. The first way is the

integrated settings which are included in a regular Brink release. If you are deploying FreedomPay

outside of a regular Brink release, you would need to use the dynamic JSON settings. Also, ensure that

you do NOY setup both setting types as this may cause conflict.

Below is the list of all relevant fields that apply to both setting types.

Sr. No. Title Description Default Comments

1. Name Any name that you would like to identify the payment device with

Enter name

2. Model The payment device integration type

Select FreedomPay

3. Address (Uri Address)

The address of the FreedomPay Service that communicates with FreedomPay

Add your system’s address (for e.g. http://127.0.0.1)

4. Port The default port that the POS uses to communicate with the FCC

1011

5. Secondary Port The secondary port the register uses to communicate with the FCC

8090

6. Timeout (sec) The brink timeout. 140 This value should be greater than the client timeout of 135 seconds

7. Merchant ID Defined by FreedomPay This ID is provided by FreedomPay. Called “StoreID” on the FreedomPay side.

8. Terminal ID Unique per location This ID is provided by FreedomPay

9. Open Cash Drawer

The cash drawer will open when the tip is applied at the payment device.

False (unchecked)

10. Show Tip Amount Not Applicable for FreedomPay

11. Show Line Items Displays the order items on the payment device

True (checked)

This applies only for Lane 7000 devices

12. Gift Card Mode Integrated or Passthrough Integrated

13. Auto Tender Enabled

True (checked)

14. Card Input Methods

Swipe/Tap/Insert True (checked)

INTEGRATED SETTINGS

The payment device must also be configured for a specific location using the Brink Settings Editor.

1. Navigate to the settings editor for your location using the Brink Admin Portal.

2. Navigate to the “Payment Devices” section and click the “Add Payment Device” button.

3. Settings descriptions and default values can be found in the table above.

4. Fill in all the settings required above and click on the “OK” button.

5. Navigate to Register > Edit your register > Peripherals > Scroll Down and select the payment

device you just added from the “Payment Device” drop-down list

6. Check that you do not have a payment device already added under the “Integrations” tab. If one

is already selected, select and remove it from the list and click “OK”.

7. Publish the settings.

JSON SETTINGS (Only use for out-of-release deployments)

1. Add new integration settings in the Settings Editor (Settings Editor > Integrations > Add New

Integration.

2. Paste the following json string into the configuration textbox.

{

"CardInputMethod":"Swipe, Tap, Insert",

"UriAddress":"http://127.0.0.1",

"Port":1011,

"TerminalId":"xxxx",

"GiftCardProcessingMode":"Integrated",

"IsSwipeAheadEnabled":false,

"Model":"FreedomPay",

"Name":"FreedomPay Device",

"OpenCashDrawer":true,

"PromptForTip":true,

"PromptForTotal":true,

"ShowTipAmount":true,

"MerchantId":"xxxx",

"SecondaryPort":8090,

"AutoTenderEnabled":true,

"ForceOffline":false,

"PaymentMethods":"CreditCard, GiftCard, DebitCard, ManualCreditCard",

"ShowLineItems":true,

"Timeout":140

}

3. Replace the MerchantID and TerminalID with the values provided by FreedomPay

Note: Ensure that the name entered in the screenshot above matches the file name of the integration

you will be deploying. i.e. if the filename is “Brink.Hardware.PaymentDevice.FreedomPay.dll” then the

name should be “FreedomPay”.

4. Click Ok to save.

5. Navigate to Register > Edit your register > Integrations > Scroll Down and select Add Integration.

6. 7. Select FreedomPay by clicking the checkbox and then clicking OK.

8. Check that you don’t have a payment device already selected under the “Peripherals” section. If

one is already selected, select “None” from the “Payment Device” drop-down list.

9. Click OK on the Edit Register screen.

10. Publish your settings.

DEPLOYMENT

STANDARD RELEASE If this deployment is part of a regular Brink release, you do not need to deploy anything additional.

OUT-OF-BAND RELEASE In case of FreedomPay being deployed outside of a regular Brink release, following steps must be

followed to install FreedomPay onto the existing Register.

Note: We are assuming that all the setup in the steps above is completed first.

1. Stop the register.

2. Ensure the payment device is plugged in.

3. Ensure that the Freeway Server and Client Services are up and running (restart preferably).

4. Ensure that your FreedomPay settings have been published to the register.

5. Unzip the FreedomPay dll files:

o Brink.Hardware.PaymentDevice.FreedomPay.dll

o Brink.Hardware.PaymentDevice.FreedomPay.pdb

to the folder C:\Brink\Pos

6. Start the register.

7. New orders will now be connecting to the FreedomPay Payment Device attached to the system.

8. Run a transaction to ensure that it is working properly. You can refund it afterwards if it was a

live transaction.

QUICK SMOKE TEST

By this point, you should have all of the following setup:

- Payment device and it’s drivers

- FCC software installed and configured

- Settings editor settings configured and published

1. You can now run a test transaction. If you are running a test in production, you can now go

ahead and refund the test amount.

2. After the test, navigate to the Windows Event Viewer and section for Brink and ensure that you

do not see any errors related to FreedomPay being logged.

3. Verify that the integration is successfully loaded by checking the windows event viewer for

brink. You should see a message like:

“Located Brink.Hardware.PaymentDevice.freedompay.dll at

C:\Brink\pos\Brink.Hardware.PaymentDevice.freedompay.dll”

SUPPLEMENTAL DETAILS

ENABLING TIPS ON THE DEVICE

If you would like to enable tips on the device:

1. Open the following config file: C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect\FreewayClientService.exe.config

2. Update the following keys value to "true": <add key="promptForTip" value ="true"/>

3. Task Manager > Services > Right click on “FCCClientSvc” and Restart.

Note: While at the "promptForTip" key in the config file, there is an additional setting that may be of use

to you, “tipPrompts”. This key will allow you to set the default tip amounts that are displayed to the user

on the device. See the key below as well as the default values for it.

<add key="tipPrompts" value ="15,18,20" />

TIMEOUTS

There are three timeouts that we typically need to know about:

1. LANE TIMEOUT

This timeout would be the first one to be hit if there is not activity on the device and the POS is still

waiting for a response. Below is the key with the default value of 90 seconds. This can be found in the

following file:

C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect\FreewayClientService.exe.config

<add key="laneTimeout" value="90" />

2. CLIENT TIMEOUT

This timeout should always be greater than the lane timeout and less than the brink timeout. Below is

the key with the default value of 135 seconds. This can be found in the following file:

C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect\FreewayServerService.exe.config

<add key="clientTimeout" value="135" />

3. BRINK TIMEOUT

This timeout is found in the Settings Editor setting within the FreedomPay settings (See SETTINGS

EDITOR SETTINGS section for more details). It must always be greater than the clientTimeout. If a brink

timeout occurs, this means that we do not know the state of the transaction we were waiting for. In this

case, we will automatically cancel the last transaction so that the customer is not accidentally double

charged. It is currently defaulted to 140 seconds in settings editor.

UPGRADE TO A NEW FCC VERSION

To upgrade to a new FCC version, you do not need to uninstall the existing FCC software.

1. Extract the new version.

2. Locate the FreewayCommerceConnect.exe inside the lDISK1 folder.

3. Right click on the executable and select “Run as an Administrator.”

4. It should now install the new version overtop the existing version.

5. Run a test transaction to ensure that everything is working as expected.

UPGRADING THE PAYMENT DEVICE TO USE A NEW PACKAGE

A device can be loaded with specific settings for that customer, as well as the customers logo on the

payment device screen. To upgrade the package you must first download it from FreedomPay.

Below is a link to generic packages. For customer specific packages please contact FreedomPay

https://freedompay.atlassian.net/wiki/spaces/PIT/pages/907509761/UPP+PAL+Packages

1. Extract the package onto your local system. 2. Stop the Freeway Server and Client services. 3. Copy and paste the extracted package's contents to folder

"C:\ProgramData\FreedomPay\Freeway Commerce Connect\pal".

NOTE: Any config files or settings that were in this folder will be overridden. It would make sense to make a backup of the contents of the folder, just in case, you would like to rollback to the previous package if something went wrong.

4. Start the Freeway Server and Client services. 5. Plug the device into your register. 6. Give the device 10-15 minutes as the device may reboot multiple times. 7. Once the device is ready, it will be on a waiting screen, usually with the company’s logo.

DOWNGRADING THE PAYMENT DEVICE TO USE AN OLDER PACKAGE

A device can be loaded with specific settings for that customer, as well as the customers logo on the

payment device screen. To downgrade the package you must first download it from FreedomPay.

Below is a link to generic packages. For customer specific packages please contact FreedomPay

https://freedompay.atlassian.net/wiki/spaces/PIT/pages/907509761/UPP+PAL+Packages

1. Download PALClear.bat and run (you can download the file and store it anywhere on your system). The file can be downloaded from here

PALClear.bat

2. Extract the package onto your local system. 3. Stop the Freeway Server and Client services. 4. Copy and paste the extracted package's contents to folder

"C:\ProgramData\FreedomPay\Freeway Commerce Connect\pal".

NOTE: Any config files or settings that were in this folder will be overridden. It would make sense to make a backup of the contents of the folder, just in case, you would like to rollback to the previous package if something went wrong.

5. Start the Freeway Server and Client services. 6. Plug the device into your register. 7. Give the device 10-15 minutes as the device may reboot multiple times. 8. Once the device is ready, it will be on a waiting screen, usually with the company’s logo.