Configuration: Payment Gateway - FreedomPay
- Sarah Holst
- Leigh Bush
Overview
The FreedomPay Payment Plugin is an option for resort customers processing credit cards in the US and Canada. This plugin is integrated with RTP|One, so a token captured in an Aspenware ecommerce transaction can be used for generating a refund through the RTP|One POS, as well as for native RTP|One functions like Resort Charge and DTL. For a complete list of payment gateway features, please see Overview: Payment Gateways.
Setup Checklist
1. FREEDOMPAY TASKS |
|
|---|---|
| Prerequisite |
2. COMMERCE TASKS |
|
Update Settings Required
| Prerequisite |
Configure the FreedomPay Payment Gateway required
| Detailed Setup |
Prerequisite Tasks
NOTE: If you have an existing integration with TRI and have been using Payeezy with a TransArmor Token (TA Token) and now wish to continue using the TA Token with FreedomPay, this guide will walk you through the conversion. New customers who have an existing integration with TRI and want to use FreedomPay with their Aspenware platform may also need to follow this process.
FreedomPay Tasks
Obtain a FreedomPay Merchant account. If you don't already have one, you can sign up here: FreedomPay.
FreedomPay will ask to provide an HPC domain to use when setting up your account. The HPC checkout domain is the domain/website that is going to be hosting the FreedomPay iframe. This will be your store domain without any paths. So for example, it should look something like this: https://shop.aspenware.com.
To activate your production environment you will need to obtain a Store ID, Terminal ID, and ESKey from FreedomPay. Make a note of these for use later in this guide. You can create a new ESKey in the FreedomPay Dashboard, if needed. (Go to Administration > Enhanced Security Keys)
Create shared token groups (Required for resorts using RTP|One)
If you are using FreedomPay in both your ecommerce platform as well as RTP|One, with the intent of passing tokens that will support ecommerce refunds, COF purchases, Resort Charge, DTL, or other native RTP|One functionality, you must request that FreedomPay includes all of your Store ID’s in a “Shared Token Group”. Contact FreedomPay Technical Support (or call 888-495-2446) for assistance in creating the group.
IMPORTANT: If the store IDs are not included in the shared token group, they will be rejected by the FreedomPay gateway with an “Invalid Token” response. Also, any tokens created and stored prior to the Store ID being added to the Shared Token Group will also generate an “Invalid Token” response.
Settings
Update the following settings in Aspenware Commerce Admin by going to Configuration > Settings > All settings (advanced) and Search for the following:
ecommercesettings.allowtransferofcc
Click Edit.
Set Value to TRUE and click Update.
ecommercesettings.allowstorageofcc
Click Edit.
Set Value to TRUE and click Update.
IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.
Detailed Setup Guide
Set Up GL Reporting
Determine Communication Requirements
Configure Payment Gateway
Activate FreedomPay Payment Provider Widget
Initiate Test Transactions
1. Set Up GL Reporting
Work with your Aspenware Representative (support@aspenware.com) to set up the GL Report so you can reconcile GL reporting in the POS and payment gateway.
2. Determine Communication Requirements
FreedomPay is an international payment gateway, meaning consideration must be given to the communication requirements for the individual countries in which your resort conducts business. Some countries have specific requirements for communication to customers on order confirmation emails, cancelation policies, etc. Verify any country-specific requirements with your FreedomPay Service Representative. Talk with your Aspenware Representative (support@aspenware.com) about customizing the email template if necessary.
3. Configure FreedomPay Payment Gateway Plugin
Go to Configuration > Payment Methods in Admin.
Click Edit on the FreedomPay payment gateway.
Check Is active and Save. Ensure that only the FreedomPay payment gateway is set to ‘Is active.’
Select Configure on the FreedomPay payment method.
Complete the following fields:
Use Sandbox: Check for test and uncheck for prod.
Use TA Tokens for Payment Plans: Check this box only if your resort has been set up specifically to use TransArmor tokens
Selling System Name: Enter the system name and/or URL of the store. Cannot exceed 35 characters. Example: Shop.PeakResort.com
ES Key: Obtain from FreedomPay (See above).
Store ID: Obtain from FreedomPay (See above).
Terminal ID: Obtain from FreedomPay (See above).
Version: For Aspenware Commerce 2.32, enter v1.5.
CSS Styling: For initial configuration, an Aspenware Development will be required to extract specific style elements from the customer's theme to be incorporated into the FreedomPay Plugin.
html{font:14px Arial,sans-serif}form{padding:3px}input{font-family:Lato,Helvetica,Arial,sans-serif;font-weight:400;opacity:1;position:relative;z-index:10;height:54px;line-height:54px;font-size:15px;border-radius:0;border:1px solid #c2c2c2;border-top-style:solid;border-right-style:solid;border-bottom-style:solid;border-left-style:solid;border-top-style:solid;border-right-style:solid;border-bottom-style:solid;border-left-style:solid;border-style:solid;background:#fff;min-width:75px;margin-left:0;padding:0 8px 0 8px;max-width:100%!important}input:focus{outline:none;box-shadow:0 0 0 .75px #4d90fe}label{position:relative;display:block;font-family:Lato,Helvetica,Arial,sans-serif;font-size:13px;text-transform:uppercase;font-weight:700;color:rgba(0,0,0,.5);margin:0 0 5px 5px}button{color:#fff;border-color:#122549;background-color:#122549;text-transform:uppercase;font-weight:700;letter-spacing:.085em;font-family:Lato,Helvetica,Arial,sans-serif;font-weight:400;opacity:1;display:inline-block;margin-bottom:0;padding:0 15px!important;cursor:pointer;user-select:none;text-align:center;vertical-align:middle;white-space:nowrap;text-transform:capitalize;border:1px solid;border-radius:0;background-image:none;font-size:16px;font-weight:400;height:44px!important;line-height:3;text-decoration:none}Requires Billing Address: Check to supply postal code/zip for AVS. (You can edit which fields are captured under Settings/Customer Settings/Address Form Fields.
4. Activate FreedomPay Payment Provider Widget
Go to Configuration > Widgets.
Select the FreedomPay Payment provider widget and click Edit.
Check the Is active checkbox to make the widget active.
Leave Display order at 1.
Click Update to save the settings.
5. Initiate Test Transactions
Test a live credit card for each type of accepted credit card (Visa, Amex, Discover, Mastercard) to ensure the gateway is processing payments properly once setup is completed.
Common Troubleshooting Guide
Q: I am not seeing my transactions in my FreedomPay dashboard. What went wrong?
A: Check that you are using the correct set of credentials, and looking at the correct dash.
For example, If your URL includes the letters “UAT”, you are looking at the test environment. You will not see transactions that occurred in your production environment reported there.
(enterprise-services.uat.freedompay.com)
Q: When I go to the checkout page, my credit card fields are not appearing. What do I need to do?
A: This happens if FreedomPay is not able to verify your credentials. Start by verifying that your credentials are entered correctly, and don't have a bank leading space. You can also log into the FreedomPay dashboard, and issue a new Extended Security Key, under the Administration tab. Finally, if those steps do not work, reach out to FreedomPay to verify your credentials or request new ones.
Q: The checkout page looks odd - the fonts change halfway through. How can I fix this?
A: The FreedomPay Plugin requires CSS styling so that the hosted fields are consistent with your theme. An Aspenware developer’s assistance is required to extract the required HTML for your theme. Please reach out to your Aspenware Service Representative (support@aspenware.com) to schedule this service.