Connecting FreedomPay as the Payment Gateway in RMS using the Direct to Freeway integration is explained in this article.
What is the FreedomPay Direct to Freeway Integration?
The FreedomPay Direct to Freeway integration is a Payment Gateway connection between RMS and FreedomPay's Freeway payment service. Connecting FreedomPay as the Payment Gateway in RMS enables secure payment processing for the Guest Portal using FreedomPay's Direct to Freeway integration.
Use this when a property in the United States needs to take online card payments through RMS or the Guest Portal. Card details are entered and processed in Freeway rather than in RMS, so card data is never stored in RMS.
Please Note! FreedomPay is a Payment Gateway available to customers in the United States.
Important! Card Not Present Transactions, Credit Card Tokens and Pre-Authorisation Tokens require EFTPOS Terminal setup using FreedomPay's FCC Integration, which must be completed after the steps outlined in this article.
Payment information and payment processing occur securely in Freeway, with encrypted data sent back to RMS as shown in the diagram below.
Direct to Freeway Integration Data Flow:
1: RMS (POS) sends POSRequest to Freeway
2: Freeway sends POSResponse to RMS (POS)
What Do You Need Before Connecting FreedomPay?
Collect the following before starting the setup in RMS.
- The property's Store ID, supplied by FreedomPay's boarding team.
- The property's Terminal ID, supplied by FreedomPay's boarding team.
- An Enhanced Security Key, generated in FreedomPay's Enterprise Portal using the Enterprise Code, Username and Password provided by FreedomPay's boarding team.
- Port forwarding and a static IP address completed by a network administrator, as set out in the network requirements below.
Network Requirements for the FreedomPay Direct to Freeway Integration
A network administrator is required to complete port forwarding on the local network router to Port 1011 for HTTP or 1013 for HTTPS, and provide a static IP address for the connected EFTPOS terminal, which will be used as the FCC Server URL in RMS.
The following endpoints apply to FreedomPay's Direct to Freeway integration.
| Platform | Endpoint URL |
|---|---|
| Live | https://cs12.freedompay.us/Freeway/Service.asmx |
| Test | https://cs.uat.freedompay.com/Freeway/Service.asmx |
Both endpoints use outbound port 443, require no inbound port, and resolve to the IP address range 64.74.156.0/24.
How do I Create a FreedomPay Enhanced Security Key?
To create an Enhanced Security Key for connecting to FreedomPay in RMS, have your System Administrator complete the following in FreedomPay's Enterprise Portal.
- Log into FreedomPay's Enterprise Portal using the property's Enterprise Code, Username and Password provided by the FreedomPay boarding team and select Login.
-
- Navigate to Administration in the Toolbar Menu and select Enhanced Security Keys.
-
- Select Create New.
-
- Enter a Description.
-
- Select Create.
-
- Select the Copy icon and safely store the copied Enhanced Security Key for RMS Setup.
-
Change tracking, delete this paragraph before publishing: the image of the endpoint table has been replaced by the text table in the Network Requirements section above, so screen readers and AI search can read the endpoint values.
Please Note! Some Users may not see or have access to the functions mentioned in this article. CLICK HERE to find out more.
How do I Set Up FreedomPay as the Payment Gateway in RMS?
- Go to Setup > Property Options > Property Information.
- Select Edit on an existing Property.
- Navigate to the Payment Gateway tab.
- Select the toggle Ecommerce Online Payment Gateway.
- Select FreedomPay as the Payment Gateway.
- Enter the ESKey (FreedomPay Enhanced Security Key), StoreID and TerminalID.
- Select a Pre Authorization Calculation option.
- Select the checkbox Warn if no Pre-Authorization Exists on Check In (Optional).
- Select Save/Exit.
Continue to setup EFTPOS Terminals using FreedomPay's FCC Integration to enable creating Credit Card Tokens and processing card-not-present transactions in RMS. That setup uses the EFTPOS (Payment Gateway) Terminal Payment Gateway toggle on the same Payment Gateway tab, where FreedomPay is selected as the Payment Gateway and the terminal's static IP address is entered as the FCC Server URL.
FreedomPay Support & Troubleshooting
Responses sent from Freeway for transactions will be displayed in RMS as shown below. A failed transaction shows the Freeway response message in a dialog, for example "Process EFTPOS Receipt: FreedomPay EFTPOS Payment Failed: Invalid Token".
- For a full list of response messages that can be received, refer to sections one and two in FreedomPay's Error Codes documentation.
- For assistance with using FreedomPay as the Payment Gateway in RMS, customers can log a Support Ticket to contact RMS Support.
- FreedomPay can use the RMS Partner Portal to contact RMS Support and track outstanding tickets with RMS.
- RMS Customer Support may escalate a reported issue to FreedomPay using the information below.
Contacting FreedomPay Tech Support
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/
When contacting FreedomPay Tech Support, it is important to ensure that you have gathered the required information that will be needed to diagnose and resolve your problem. Commonly required items are:
- Name of POS and Integration Type (Windows FCC, HPC, HPP, Direct to Freeway, etc.)
- FCC Logs (if applicable)
- RequestIDs (if available)
- Whatever 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
With the above steps being completed, FreedomPay's tech support will review your issue and assign it a priority level. This level will be primarily determined by how much your particular issue impacts your business and whether you are still able to function in production with this issue around. The severity levels and response times are:
| Severity | Description | Time to Respond |
|---|---|---|
| P1 | A problem that severely impacts your use of the software in a production environment (such as loss of production data or when your production systems are not functioning). The situation halts your business operations, and no procedural workaround exists. | 30 minutes |
| P2 | A problem where the software is functioning, but its use in a production environment is severely reduced. The situation is causing a high impact on portions of your business operations, and no procedural workaround or a non-ideal workaround exists. | 2 to 4 hours |
| P3 | A problem that involves partial, non-critical loss of use of the software in a production environment. For production environments, there is a medium-to-low impact on your business, but your business continues to function, including by using a procedural workaround. | 48 hours |
| P4 | A general usage question, reporting question, trivial error, or recommendation for a future product enhancement or modification. For production environments, there is low to no impact on your business or the performance or functionality of your system, including by using a procedural workaround. | 72 hours |
Please bear in mind that the best way to assist FreedomPay tech support is to ensure that you have obtained as much information about the issue as you are able and that you have already gone through your internal tech support process, in which you confirmed that the issue lies with FreedomPay.
Related Articles
Comments
0 comments
Please sign in to leave a comment.