Connecting FreedomPay as the Payment Gateway in RMS

Overview

Connecting FreedomPay as the Payment Gateway in RMS using FreedomPay's Direct to Freeway Integration and FCC Integration enables secure payment processing through the Guest Portal and RMS Booking Engine, as well as card-present and card-not-present transactions in RMS using the connected pinpad EFTPOS terminal.

Payment information and payment processing occur securely in Freeway, with encrypted data sent back to RMS. Payments and Credit Card Tokens created using the connected EFTPOS terminal use FreedomPay's middleware application (FCC Client) to transfer encrypted data between the terminal, Freeway and RMS.

Windows FCC Integration Data Flow

1. RMS (POS) sends POSRequest to FCC Server Service

2. FCC Server sends POSRequest to FCC Client

3. FCC Client engages Point of Input (EFTPOS Machine)

4. EFTPOS Machine sends a Response to FCC Client

5. FCC Client sends Response to Freeway

6. Freeway sends the Response back to FCC Client

7. FCC Client passed Response to FCC Server

8. FCC Server sends Response to RMS (POS)
   
    

To complete the connection to FreedomPay in RMS, you will need: 

• FreedomPay Store ID and Terminal ID (supplied by FreedomPay's boarding team)

• Enhanced Security Key

• DMP Activation Key in FreedomPay's Enterprise Portal.

Freedom Enhanced Security Key

To create an Enhanced Security Key for connecting to FreedomPay in RMS, have your System Administrator complete the following:

1. Log into FreedomPay's Enterprise Portal using the property's Enterprise Code, Username and Password provided by the FreedomPay boarding team and select Login.
    

2. Navigate to Administration in the Toolbar Menu and select Enhanced Security Keys.
   
    

3. Select Create New.
   
    

4. Enter a Description.
   
    

5. Select Create.
   
    

6. Select the Copy icon and safely store the copied Enhancement Security Key for RMS setup.
    

Device Management Portal Activation Key

A Device Management Portal (DMP) Activation Key and FCC Client is required for each network that will be using the connection to FreedomPay in RMS with EFTPOS terminals.

Steps to generate a DMP Activation Key:

1. Log into FreedomPay's Enterprise Portal using the property's Enterprise Code, Username, and Password provided by the FreedomPay boarding team and select Login.
   
    

2. Navigate to Device Management in the Toolbar Menu and select Activation Keys.
   
    

3. Select Generate
   
    

4. Copy the key and store securely for FCC Client setup.
    

Network Information

A Network Administrator is required to complete port forwarding on the local network router and firewall to Port 1011 (HTTP) or 1013 (HTTPS) and provide a static IP address for the connected EFTPOS terminal (used as the FFC server URL in RMS).

The following endpoints apply to FreedomPay's Windows FCC integration.

Windows FCC

The following IP Addresses need to be allowed through your Firewall.  
Please allow all ports for these IP addresses.  

FCC Client Setup

1. Download the FCC Client zip file on a Windows computer on the same network as the EFTPOS terminals.
   (Contact Freedom Pay to obtain the FCC Install Package file).

2. Locate the CONFIG file labelled FreewayServerService in the extracted folder and choose Open With Notepad or a similar text editing application.
    

3. Edit the floorLimit value between the quotation marks to “0” in the text document.
    

4. Save the changes made and close the XML file.

5. Locate the XML file labelled 'LaneConfig' in the extracted folder and choose Open With Notepad or a similar text editing application.
   
    

6. Enter the last eight digits of the EFTPOS Terminal's serial number between the quotation marks in the text document.
    

7. Save the changes made and close the XML file.

8. Connect the EFTPOS terminal to an RMS workstation using the provided USB cable.

9. Right-click the FreewayCommerceConnect application in the extracted folder and choose Run as Administrator.
   
    

10. Follow the onscreen prompts from Windows and select Run Anyway.

11. Select Next on the FreedomPay installer.
     

12. Enter the Device Management Portal Activation URL.
     

    • The URL will default to the Production URL.

    • To switch to UAT, replace the Production URL with the UAT URL below:

13. Enter the Device Management Portal Activation Key generated in the FreedomPay Enterprise Portal and choose Next
    
     

14. Select Custom Setup Type
    
     

15. Select the following setup options and follow the on-screen prompts to finish installation.

UAT & Production

To switch between the FreedomPay UAT and FreedomPay Production environments, follow the instructions below.

1. To switch to the FreedomPay UAT environment, select the checkbox FCC Test Client in the Custom Setup below.
   
    
2. The FCC Client can be toggled between UAT and Production by opening the FCC Client and selecting Configure after the initial installation is completed.
3. Replace the Device Management Portal URL with the URL for the required FreedomPay environment using the URLs below.

4. Locate the CONFIG file labelled FreewayServerService.exe.config in the extracted folder and choose Open With Notepad or a similar text editing application.
   • Default file path: 
     C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect.
     
      
5. Replace cs.uat.freedompay.com with https://cs.freedompay.us to switch from UAT to Production.
   
    

6. Replace:
   <add key="freewayServer" value="https://cs.uat.freedompay.com/" />
   
   with: 
   <add key="freewayServer" value="https://cs.freedompay.us/" />
   
   to switch from UAT to the Production environment.
   
    

7. Save the changes made and close the CONFIG file.

8. Locate the CONFIG file labelled FreewayClientService.exe.config in the extracted folder and choose Open With Notepad or a similar text editing application.

   • Default file path: 
     C:\Program Files (x86)\FreedomPay\FreewayCommerceConnect.
     
      

9. Replace:
   <add key="freewayServer" value="https://cs.uat.freedompay.com/" />
   
   With: 
   <add key="freewayServer" value="https://cs.freedompay.us/" />
   
   to switch from UAT to the Production environment.
   

10. Replace: 
    <add key="cardStorUrl" value="https://cs.uat.freedompay.com/CardStor/CardStorService.asmx" />
    
    With:
    <add key="cardStorUrl" value="https://cs.freedompay.com/CardStor/CardStorService.asmx" />
    to switch from UAT to the Production environment.
    
     

11. Save the changes and close the CONFIG file.

PAL Package Update

Download the Lane7000 PAL Update Package.zip and complete the steps outlined in PAL Package Deployment Guide v2.0.pdf to update the EFTPOS terminal after it has been connected.

Setup the Payment Gateway in RMS

1. Navigate to Setup > Property Options > Property Information.

2. Select the Edit icon on an existing Property.
    

3. Navigate to the Payment Gateway tab.

4. Select the toggle Ecommerce Online Payment Gateway.

5. Select FreedomPay as the Payment Gateway.

6. Enter the ESKey (FreedomPay Enhanced Security Key), Store ID and Terminal ID.

7. Select a Pre Authorisation option.

8. Select the checkbox Warn if no Pre-Authorisation exists on Check-in. (Optional)

9. Select the toggle EFTPOS Terminal Payment Gateway.

10. Select the Payment Gateway as FreedomPay.

11. Enter the FCC Server URL.

    • The FCC Server URL is the IP address for the connected EFTPOS terminal (ending in 1011 for HTTP or 1013 for HTTPS).

12. Select the checkbox Allow Blind Refunds. (Optional)

13. Select Save/Exit.
    
     

14. Navigate to Setup > Lookup Tables > EFTPOS (Pymt Gateway).

15. Select the Add icon.

16. Select a Property and enter a Description to identify this EFTPOS terminal.

17. Select Save/Exit.
    
     

Result

This EFTPOS terminal will be available for selection on the Receipt and Refund screens in RMS, enabling card-present and card-not-present transactions in addition to Credit Card Token creation using the selected terminal. Selecting Process on the Receipt screen will prompt for card information on the connected EFTPOS terminal.

Support & Troubleshooting

1. Responses sent from Freeway for transactions will be displayed in RMS as shown below:
   
2. For a full list of response messages that can be received, refer to sections one and two in FreedomPay's ErrorCodes v6.0.pdf.
3. For assistance with using FreedomPay as the Payment Gateway in RMS, customers can log a Ticket to contact RMS Support.
    

FreedomPay Support

FreedomPay can use the RMS Partner Portal to contact RMS Support and track outstanding tickets with RMS.

When the need arises to contact FreedomPay Tech Support, you can do so via phone or email. These lines are available 24/7 to handle your issues, and their contact information can be found below:

• Phone:
  • 888.495.2446 (US)
  • +44-2030148966 (UK)
• Email: techsupport@freedompay.com
• Status Page: https://status.freedompay.com/

Important: 

When contacting Tech Support, ensure you have gathered the following information:

• Name of POS and Integration Type (Windows FCC, HPC, HPP, Direct to Freeway, etc.).
• FCC Logs (if applicable), RequestIDs (if available).
• Any error code(s) you are receiving.
• A clear description of what you are doing and what is happening. Confirmation that you have completed the steps outlined in your L1 Troubleshooting guide.