Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
1. POS Tasks | |
|---|---|
| PREREQUISITE |
2. Infrastructure Tasks | |
| PREREQUISITE |
3. Commerce Tasks | |
| PREREQUISITE |
Update Settings REQUIRED
| PREREQUISITE |
Update Language String OPTIONAL
| PREREQUISITE |
| DETAILED SETUP |
| DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
POS Tasks
Switching your RTP|One POS over to Heartland Payments requires working with your Active, Heartland, and Aspenware Representatives. It also requires RTP|One to be on the latest 2021 version.
Infrastructure Tasks
NOTE: If you are interested in implementing Heartland Payments, please reach out to Phil Kilpatrick at Heartland (philip.kilpatrick@e-hps.com).
Ensure that your account with Heartland Payment Systems is set up. You will receive a Public Key and a Secret Key from Heartland to input into your Aspenware Commerce setup. Make a note of these. Note that the public and secret keys are unique, and cannot be interchanged between Sandbox and Production environments.
Work with your Aspenware Representative to ensure that the Unity rtp-config.json file is set up properly. Ensure the following settings are set.
UsePaymentCardTokenTable set to TRUE
EncryptPaymentCardTokenValue set to FALSE
Validate the credit-related settings in the Unity rtp-config.json when that switch occurs.
If on a version earlier than 2.27, your Aspenware Representative will also need to set the following in the Azure appsettings.json file:
AllowStorageOfCC = TRUE
AllowTransferOfCC = FALSE
IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.
Commerce Tasks
Work with your Aspenware Representative to install the Heartland Payments Plugin. Go to Configuration > Local Plugins and find the Heartland Payment Provider plugin to install and enable the plugin. You need to restart the application for the plugin install to take effect.
Next, from Configuration > Settings > Payment methods choose to Edit the Heartland Payment Provider. Check Is Active and Update to activate.
IMPORTANT: Make sure to mark all other payment gateways, except Affirm, as inactive so that only the Heartland Payment Plugin is installed for payment. Aspenware strongly recommends working with your Aspenware representative to uninstall other payment gateway plugins that are no longer in use.
Settings and Language Strings
This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.
Language Strings
Go to Configuration > Languages > English, search for the resource name: 'Checkout.ResortCharge.UsePaymentCreditCardForResortCharge.' Change the value associated with this string to a reminder that the card the guest has entered will be saved for Resort Charge use in RTP|One.
Settings
Update the following settings in Commerce Admin.
Go to Configuration > Settings > All settings (advanced)
Search for ecommercesettings.allowtransferofcc
Click Edit.
Set the Value to FALSE and click Update.
Search for ecommercesettings.allowstorageofcc
Click Edit.
Set the Value to FALSE.
Click Update.
IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.
Detailed Setup Guide
1. Configure Payment Method
Once installed, go to Configuration > Settings > Payment methods. Select to Configure ‘Heartland Payment Provider.’
Use Sandbox: checked for test environment, Unchecked if configuring for a production environment.
Public Key: This will be received from Heartland to input. Note that the public and secret keys are unique, and cannot be interchanged between Sandbox and Production environments.
Secret Key: This will be received from Heartland to input. Note that the public and secret keys are unique, and cannot be interchanged between Sandbox and Production environments.
Requires Billing Address: Must be checked, so AVS verification can function.
The following values can be entered from the Configure screen to customize the field labels and error messages on the payment page. The following items can be customized:
Card Number Label:
Card Number Placeholder:
Card Number Invalid Title:
Card Number Invalid Message:
Expiration Label:
Expiration Placeholder:
Expiration Invalid Title:
Expiration Invalid Message:
CVV Label:
CVV Placeholder:
CVV Invalid Title:
CVV Invalid Message:
Name Label:
Name Placeholder:
Name Invalid Title
Name Invalid Message
2. Install and enable the Heartland and Global Payments Payment Provider Widget
Go to Configuration> Widgets
Scroll to find the ‘Heartland and Global Payments Payment Provider’ widget in the list.
Click Edit.
Check ‘Is Active’.
Click Save.
Common Troubleshooting
Q: What functionality is and isn’t available to me because of having Heartland as a Payment Provider?
A: Good news is that using Heartland allows you to enable a number of advanced features, most notably Payment Plans and Resort Charge in RTP|One. Because Heartland is a preferred tokenization provider for RTP|One, if RTP|One is your POS, resorts that use Heartland can offer guests resort charge, direct to lift, and token capture for refunds in the POS. Updating the resort charge credit card in my account is also supported. Subscriptions, Apple Pay, Google Pay, Pay Pal, and Storing CC for future purchases are NOT currently supported with Heartland.
Q: I’m switching from another payment provider to Heartland, but the old payment provider UI continues to display on top of the new payment method on the Payment UI during checkout.
A: You must uninstall the previous payment provider plugin and ensure that Heartland is the ONLY payment provider plugin that is enabled. Go to Configuration > Payment Methods in Admin to ensure that Heartland is the ONLY payment provider installed and enabled.
Q: Can I set up Heartland, with test credentials in my test environment?
A: Separate from your Merchant Account, anyone can register for a free developer account with Heartland. Registered users will obtain a set of sandbox keys for testing. If you use multi-use tokens you will need to contact the Online Payments Team, and request that your account be enabled for multi-use tokenization. If you are working with RTP|One, you are likely using multi-use tokenization.