| Table of Contents |
|---|
...
1. POS Tasks | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| ||||||||||||
2. Infrastructure Tasks | |||||||||||||
|
| ||||||||||||
3. Commerce Tasks | |||||||||||||
|
| ||||||||||||
Update Settings
|
| ||||||||||||
Update Language String
|
| ||||||||||||
|
| ||||||||||||
|
|
...
| Info |
|---|
NOTE: If you are interested in implementing Heartland PaymentsPayment Systems, 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.
In order to obtain test credentials from Heartland Payment Systems, you will need to register for a free developer account. Registered developers will receive 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. (Note that if you are using RTP|One, you are likely using multi-use tokenization.)
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
...
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.
| Note |
|---|
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. |
...
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
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.
...
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.
| Note |
|---|
IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work. |
...
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: This is the language string that displays above the Card Number box. Example: “Card Number”.
Card Number Placeholder: This is the language string that displays in the Card Number field. Example: Card Number or “XXXX XXXX XXXX XXXX”.
Card Number Invalid Title: This is the title on the message that displays if a card number is invalid. Example: “Invalid Card Number.”
Card Number Invalid Message: This is the message that displays if a card number is invalid. Example: “Invalid Card Number.”
Expiration Label: This is the language string that displays above the Expiration Number box. Example: “Expiration Date”.
Expiration Placeholder: This is the language string that displays in the field as a placeholder. Example: “MM/YYYY”.
Expiration Invalid Title: This is the title on the message that displays if an expiration date is invalid. Example: “Invalid Expiration Date”
Expiration Invalid Message: This is the message that displays if an expiration date is invalid. Example: “Card Number Invalid. Example: “Expiration Date Must Be in MMYY”.
CVV Label: This is the language string that displays above the CVV box. Example: 'CVV”.
CVV Placeholder: This is the language string that displays in the CVV field as a placeholder. Example: “CVV”.
CVV Invalid Title: This is the title on the message that displays if a CVV is invalid. Example: “Invalid CVV”
CVV Invalid Message: This is the message that displays if a CVV is invalid. Example: “Invalid CVV Number.”
Name Label: This is the language string that displays above the Name box. Example: ‘Name’.
Name Placeholder: This is the language string that displays in the field as a placeholder. Example: “Cardholder Name”.
Name Invalid Title: This is the title on the message that displays if a name is invalid. Example: “Invalid Name”
Name Invalid Message: This is the message that displays if a Name is invalid. Example: “Cardholder name required.”
Click Save.
...
For reference, here’s how they appear on the Payment Window:
...
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: 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.
...