FreedomPay

In this article

Setup

Support

All settings to communicate with the terminal are set in FreeWayClientService.exe.config, FreeWayServerService.exe.config, and LaneConfig.xml files located on C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect.

Setup

1. Download the FCC setup folder obtained on the Partner Portal. Open FreewayCommerceConnect.exe as Administrator.
   1. In the setup you need to enter the ActivationKey provided by FreedomPay.
   2. Choose Typical setup
   3. Open C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect
   4. You might need to grant your user permission to edit the files in the folder.
      1. Right click each file.
      2. FreeWayServerService.exe.config.
      3. FreeWayClientService.exe.config.
      4. LaneConfig.xml.
      5. Click Properties -> Security -> Edit -> Grant user Read/Write/Modify permissions.

How to point the FCC to UAT

Open the following files and change:

• FreewayServerService.exe.config

  • Change freewayServer field to https://cs.uat.freedompay.com
  • Change cardStorUrl field to https://cs.uat.freedompay.com/CardStor/CardStorService.asmx

• FreewayClientService.exe.config

  • Change freewayUrl field to https://cs.uat.freedompay.com/Freeway/Service.asmx
  • Change cardStorUrl field to https://cs.uat.freedompay.com/CardStor/CardStorService.asmx
  • Select workstationID and set it to TERMINAL1. This needs to be entered into EFT settings in Hardware Station.

Connecting

Terminals can be connected via USB or WiFi/IP.

Wifi/IP:

When the terminal is not connected, it should say This Lane Closed.

1. Press 0-0-0-1 on the device to enter the settings.
2. Select CommunicationType -> WIFI -> WIFI Parameters -> Scan Networks.
3. Connect to the network you want.

With the device connected to the Wi-Fi, go to the main WIFI Parameters menu and select Default IP Configuration

1. These devices need to have a static IP to work. You can do this through a DHCP reservation on your gateway or by setting a static IP.
2. If you are performing a DHCP reservation, you can leave this menu alone and skip this step.
3. If you are setting a static IP on the device, select DHCP Activation and set it to off. Then modify the IP address, Subnet Mask, and Gateway appropriately.
4. Go back to the WIFI Parameters Menu.

5. Go to ConnectionType and set it to Server.

6. Select Port and set it to 12000.

7. Press Green to confirm the port, then press the yellow button to back out of WIFI parameters and out of the communication menu. You are prompted to Save and Reboot.

Note: If you are not prompted, then you did not select these values correctly and need to follow this page again.

8. Open LaneConfig.xml file and set the IP Address to the IP address of the terminal.

9. Set DeviceType to upp.

10. Restart both FreewayClientService and FreewayServerService in Services.

USB

When connecting through USB you need to set up the driver FreewayMsrDriverExe.exe. If there are other Ingenico drivers installed on the computer, you might need to remove them.

1. Install the FreedomPay USB Driver by running FreewayMsrLib-LibUsbDrivers.exe or FreewayMsrDriverExe.exe. This can be found in the installation directory, C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect.To ensure that the driver was run properly, open up the Device Manager, and look for the device to be listed under libusb-win32 Usb Devices.
2. Unless you intend to have multiple devices connected to the POS terminal, you should disable multilane mode. This is done by changing the following key in the FreeWayClientService.exe.config:
   1. Change multiLaneMode field to false.

3. You should also ensure that Ethernet and Bluetooth are disabled:

   1. Change useIPDevices field to false.
   2. Change useBluetoothDevices field to false.

Additional Settings

Additional settings are made by modifying FreeWayClientService.exe.config and FreeWayServerService.exe.config.

Receipt and language settings

FreeWayServerService.exe.config

FreeWayClientService.exe.config

Settings

• IP Address is the IP address used to communicate with the terminal. Should be set to 127.0.0.1.
• MainPort is the port used for communication. Should be set to 1011.
• Timeout indicates, in seconds, for how long a communication is kept alive.
• TerminalID is the identification given by FreedomPay for the terminal.
• StoreID is the identification given by FreedomPay for the store.
• LaneID refers to which settings line to use from LaneConfig.xml file.
• WorkstationID refers to the name of the machine used to make requests. Is set in the FreedomPay config files.
• ReceiptLineWidth ,the default value is set to 40 characters, the same as in LS Central.
• TokenType refers to what kind of Token is used. Default is set to 6.
• AllowPartial enables partial payments when set to true.
• EnableDCC enables DCC transactions when set to true.

Support

EFT

FreedomPay supports the core EFT functions available in LS Pay:

• Purchase
  • MOTO payments (Mail Order Telephone Order).
  • Token payments
  • VoiceAuth
• Refund
  • Stand-alone refund (no previous purchase).
  • Referenced refund (linked to previous purchase).
    1. Full referenced refund.
    2. Partial referenced refund.
• Void
  • Can void any previous transaction.
• Get last transaction
  • Returns the last transaction response received.
• Get last raw transaction
  • FreedomPay does not support GetLastRawTransaction.
• Cancel
  • FreedomPay does not support canceling from POS to PED.
• CreateToken
  • Creates a token for a card that can be stored.

Pre-authorization

• Pre-authorization
• Update pre-authorization to update amount or to prolong the authorization.
• Cancel pre-authorization to release the amount.
• Finalize pre-authorization to confirm the amount used for the transaction.

Gift cards

Gift card features have been added to the integration:

• Activate
• Add value
• Balance inquiry
• Deactivate.

Hotel data

Hotel data features have been added to the integration through AdditionalData fields:

  {Key:"IndustryType", Value: "hotel"},
  {Key:"Hotel_CheckInDate", Value: "07/26/2023"},
  {Key:"Hotel_CheckOutDate", Value: "07/29/2023"},
  {Key:"Hotel_RoomRate", Value: "51.19"},
  {Key:"Hotel_RoomTax", Value: "0.10"},

Level II data

Level II data is added in AdditionalData as key value pairs:

    {Key:"CustomerId", Value: "95239922"},
    {Key:"CustomerPONumber", Value: "PO239933"},
    {Key:"CustomerPODate", Value: "6/26/2018"},
    {Key:"CustomerCode", Value: "33223322"},
    {Key:"BillTo_FirstName", Value: "Bob"},
    {Key:"BillTo_LastName", Value: "Smith"},
    {Key:"BillTo_Street1", Value: "123 Industry Lane"},
    {Key:"BillTo_City", Value: "Testville"},
    {Key:"BillTo_State", Value: "PA"},
    {Key:"BillTo_PostalCode", Value: "19403"},

Level III data

Level III data uses LineItems to populate product information that must be sent with the request:

  {Key:"SKU", Value: "DELIV122"},
  {Key:"Description", Value: "Delivery Charge"},
  {Key:"UPC", Value: "96224"},
  {Key:"UnitPrice", Value: "10.0"},
  {Key:"Quantity", Value: "2.5"},
  {Key:"TotalAmount", Value: "26.50"},
  {Key:"TaxAmount", Value: "1.50"},
  {Key:"SKU", Value: "HUR"},
  {Key:"SaleCode", Value: "S"},