Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Setup Checklist

Insert excerpt
AE:Set-up ChecklistAE:
Set-up Checklist
nopaneltrue

1. FREEDOMPAY TASKS

  • Obtain FreedomPay Merchant Account

    Status
    colourRed
    titleRequired

  • Obtain Store ID, Terminal ID, and ESKey from FreedomPay.

    Status
    colourRed
    titlerequired

  • Create shared token groups (Required for resorts using RTP|One)

Status
colourYellow
titlePrerequisite

2. COMMERCE TASKS

Update Settings

Status
colourRed
titleRequired

  • ecommercesettings.allowtransferofcc = TRUE

  • ecommercesettings.allowstorageofcc = TRUE

Status
colourYellow
titlePrerequisite

Configure the FreedomPay Payment Gateway

Status
colourRed
titlerequired

  1. Set Up GL Reporting

  2. Determine Communication Requirements

  3. Configure Payment Gateway

  4. Activate FreedomPay Payment Provider Widget

  5. Initiate Test Transactions

Status
colourGreen
titleDetailed Setup

Prerequisite Tasks

Insert excerpt
AE:Prerequisites Tasks ExcerptAE:
Prerequisites Tasks Excerpt
nopaneltrue

Info

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)

...

Note

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

Insert excerpt
AE:Setting, Language String and/or HTML Widgets for this featureAE:
Setting, Language String and/or HTML Widgets for this feature
nopaneltrue

  • 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.

Note

IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.

Detailed Setup Guide

  1. Set Up GL Reporting

  2. Determine Communication Requirements

  3. Configure Payment Gateway

  4. Activate FreedomPay Payment Provider Widget

  5. 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.

...

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 Is active.’

  • Select Configure on the FreedomPay payment method. 

  • Complete the following fields:

    1. Use Sandbox:

    Should be checked
    1. Check for test and

    unchecked
    1. uncheck for prod.

    Client Application Name: This field is required, and should reflect the name of your store. Examples might be BIGSKY PROD or Sugarloaf Test, or the URL.
    1. Use TA Tokens for Payment Plans: Check this box only if your resort has been set up specifically to use TransArmor tokens

      Image Added

    2. Selling System Name: Enter the system name and/or URL of the store. Cannot exceed 35 characters. Example: Shop.PeakResort.com

    3. ES Key: Obtain from FreedomPay (See above).

    4. Store ID: Obtain from FreedomPay (See above).

    5. Terminal ID: Obtain from FreedomPay (See above).

    6. Version: For Aspenware Commerce 2.32, enter v1.5.

    7. 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.

      Code Block
      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}

    8. 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.

    Image Removed
    1. Image Added

View file
nameHPC Integration Guide v5.9.pdf

...

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

...