Skip to content
Magento 2 Tokenized Payment Gateway Module
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
HPS/Heartland Updated code for amasty compatibility issue fix Aug 2, 2019
HPS_Installer.php more updates to base files Jan 3, 2017 more updates to base files Jan 3, 2017 readme file changes for magento 2.1.6 version May 12, 2017
composer.json composer init Jan 9, 2017
configNav.png more updates to base files Jan 3, 2017
pMethod.png more updates to base files Jan 3, 2017


Welcome to Heartland Magento2 Extension:

This project is in ready.


We have laid out some basic requirements that you should absolutely have before working with this extension:

  • Magento v2.1.6+ (at the time of this development effort this was the current release of Magento2)
  • Experience in debugging if problems arise.
  • SSH access to server as file system owner of web directory
  • Keys for Magento connect
  • Keys for your developer or live Heartland account Once you have created an account or signed in you can view available keys by navigating to Menu->API Keys & Credentials. It is not necessary to have a live merchant account to have working certification keys.

Feature list:

Heartland supports several industry leading platforms. Magento2 is one of many. Let's review what is ready for use:

  • Checkout
  • Card Saving
  • Online Auth/Capture(invoice)
  • Online Partial Capture
  • Administrative Card delete for customer
  • Online Charge
  • Online Refund

With a Heartland integration:

  • You no longer have to worry about the burdens of PCI compliance because card data never touches your server.
  • The exchange of sensitive information occurs directly between the consumer and Heartland Payment Systems through our Portico Gateway.
  • Our convention-based jQuery plugin streamlines this process so you don’t have to worry about obtaining tokens. The plugin handles that request and appends the resulting token to your form before it posts.

Lets get to it:

If you're still with us, you have decided that this sounds like something you want to be an early adopter. Remember you must SSH into your server as the web directory owner.


Please review the updated Magento 2.1.x requirements. It is critical that your installation meets all of these before continuing

  • While it was unclear if a WAMP stack was ever supported, Magento 2.1.x now officially only supports a Linux x86-64 deployment.
  • While the documentation suggests that setting up a swap file if you have less than 2 GB, we found that there were failures during the basic Magento 2 installation when the server had less than 2 GB.
  • While Magento2 documentation on versioning indicates the difference between 2.0.x and 2.1.x should be backward compatible changes 2.1.x no longer allows php 5.5.22 or greater. 2.0.x vs 2.1.x
Latest system requirements

There are now 2 options for installing our heartland-magento2-module.

  • [PHP script] (HPS_Installer.php) The script will check system requirements for you and locate your magento instalation and create a customized ssh script to execute. If there is a problem it will tell you what the issue might be. Just SSH to your server as a user part of the web servers group and call this line
wget && php -f HPS_Installer.php | tee -a HPS_Heartland.log && sh | tee -a HPS_Heartland.log
  • Manual
Manual Installation:

Clone this repo:

git clone

From your base Magento2 directory -> app -> code (you may have to create this directory) Magento2 Documentation.

Install Dependencies with Composer:

composer require hps/heartland-php

Copy the HPS directory from this repository to your app/code directory. From the base Magento2 directory (instructions assume Ubuntu 14+)

    cd ${Magento2Instalation}
    rm -rf var/cache/*
    rm -rf var/page_cache/*
    rm -rf var/generation/*
    rm -rf var/di
    rm -rf pub/static/adminhtml
    rm -rf pub/static/frontend
    rm -rf var/report/*

The following commands should work from your Magento 2 installation directory .

    cd ${Magento2Instalation}
    php bin/magento cache:clean
    composer require hps/heartland-php
    php bin/magento module:enable HPS_Heartland
    php bin/magento setup:upgrade  --keep-generated
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy

Navigate to your admin logon. If you need the path you can retrieve it (web install usually sets this other than admin)

php bin/magento info:adminuri

This will echo out the path

Configure your store:

Open Store Configuration


Expand Sales and navigate to Payment Methods.


Fill out the form as per the instructions on the screen. Please be aware that you can change the title to anything you would like to appear on your checkout page for the consumer to see.


Support or Contact

Having trouble? Check out our documentation or contact support and we’ll help you sort it out.

You can’t perform that action at this time.