README

Heartland driver for the Omnipay PHP payment processing library

Omnipay is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Heartland support for Omnipay.

Installation

Omnipay is installed via Composer. To install, simply add it to your composer.json file:

{
    "require": {
        "hps/omnipay-heartland": "dev-master"
    }
}

And run composer to update your dependencies:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

Basic Usage

The following gateways are provided by this package:

Heartland’s Portico Gateway API
Heartland's PayPlan API

For general usage instructions, please see the main Omnipay repository.

Heartland Single-use Tokenization

The Heartland integration is fairly straight forward. Essentially you just pass a token field through to Heartland instead of the regular credit card data.

Start by following the standard Heartland Single-use Tokenization guide here: https://developer.heartlandpaymentsystems.com/documentation/v2/introduction

After that you will have a payment_token field which will be submitted to your server. Simply pass this through to the gateway as token, instead of the usual card array:

$token = $_POST['payment_token'];

$response = $gateway->purchase([
    'amount' => '10.00',
    'currency' => 'USD',
    'token' => $token,
])->send();

Testing & Certification

Testing your implementation in our Certification/Sandbox environment helps to identify and squash bugs before you begin processing transactions in the production environment. While you are encouraged to run as many test transactions as you can, Heartland provides a specific series of tests that you are required to complete before receiving Certification. Please contact Heartland to initiate certification for your integration. For eComm integrations please email our Specialty Products Team, for POS developers please email Integrations.

Support

If you are having general issues with Omnipay, we suggest posting on Stack Overflow. Be sure to add the omnipay tag so it can be easily found.

If you want to keep up to date with release announcements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.

hps / omnipay-heartland

Maintainers

Details