PHPackages                             hps/omnipay-heartland - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. hps/omnipay-heartland

Abandoned → [globalpayments/omnipay-globalpayments](/?search=globalpayments%2Fomnipay-globalpayments)ArchivedLibrary[Payment Processing](/categories/payments)

hps/omnipay-heartland
=====================

Heartland driver for the Omnipay payment processing library

v1.1.1(7y ago)510.9k1[1 issues](https://github.com/hps/omnipay-heartland/issues)GPL-2.0-or-laterPHP

Since Aug 29Pushed 1y ago2 watchersCompare

[ Source](https://github.com/hps/omnipay-heartland)[ Packagist](https://packagist.org/packages/hps/omnipay-heartland)[ Docs](https://github.com/hps/omnipay-heartland)[ RSS](/packages/hps-omnipay-heartland/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (3)Versions (7)Used By (0)

\*\*\* This library is no longer maintained! Its functionality is offered in Global Payments’ current library which can be found [here](https://github.com/globalpayments/omnipay-globalpayments). \*\*\*
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

[](#-this-library-is-no-longer-maintained-its-functionality-is-offered-in-global-payments-current-library-which-can-be-found-here-)

Omnipay: Heartland
==================

[](#omnipay-heartland)

**Heartland driver for the Omnipay PHP payment processing library**

[![Build Status](https://camo.githubusercontent.com/01234b82222b5525b0ce69b83d0a2921a1bd813fb44c6195a440ff4bae2f12de/68747470733a2f2f7472617669732d63692e6f72672f6870732f6f6d6e697061792d68656172746c616e642e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/hps/omnipay-heartland)[![Latest Stable Version](https://camo.githubusercontent.com/d23975038c2bedc5f09af866525b66434da2f8b4c427cf32421fb469bd7993f4/68747470733a2f2f706f7365722e707567782e6f72672f6870732f6f6d6e697061792d68656172746c616e642f76657273696f6e2e706e67)](https://packagist.org/packages/hps/omnipay-heartland)[![Total Downloads](https://camo.githubusercontent.com/8295314d9b2c261408fca968dc08a4ed5f770bd9bf10f37b20732d2a48491057/68747470733a2f2f706f7365722e707567782e6f72672f6870732f6f6d6e697061792d68656172746c616e642f642f746f74616c2e706e67)](https://packagist.org/packages/hps/omnipay-heartland)

[Omnipay](https://github.com/thephpleague/omnipay) is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Heartland support for Omnipay.

Installation
------------

[](#installation)

Omnipay is installed via [Composer](http://getcomposer.org/). 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
-----------

[](#basic-usage)

The following gateways are provided by this package:

- Heartland’s [**Portico Gateway API**](http://developer.heartlandpaymentsystems.com/Portico)
- Heartland's [**PayPlan API**](https://developer.heartlandpaymentsystems.com/Resource/download/payplan-devguide)

For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay)repository.

### Heartland Single-use Tokenization

[](#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:

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 &amp; Certification
---------------------------

[](#testing--certification)

[![](https://camo.githubusercontent.com/3386cfb3e57b31c6d96bbbb5c159cdd28e59a6368e7f733e5e7175ebc1fafee8/687474703a2f2f646576656c6f7065722e68656172746c616e647061796d656e7473797374656d732e636f6d2f5265736f757263652f446f776e6c6f61642f73646b2d726561646d652d69636f6e2d746f6f6c73)](https://camo.githubusercontent.com/3386cfb3e57b31c6d96bbbb5c159cdd28e59a6368e7f733e5e7175ebc1fafee8/687474703a2f2f646576656c6f7065722e68656172746c616e647061796d656e7473797374656d732e636f6d2f5265736f757263652f446f776e6c6f61642f73646b2d726561646d652d69636f6e2d746f6f6c73)

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

[](#support)

If you are having general issues with Omnipay, we suggest posting on [Stack Overflow](http://stackoverflow.com/). Be sure to add the [omnipay tag](http://stackoverflow.com/questions/tagged/omnipay) 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](https://groups.google.com/forum/#!forum/omnipay) which you can subscribe to.

If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/hps/omnipay-heartland/issues), or better yet, fork the library and submit a pull request.

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance29

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 53.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~165 days

Total

3

Last Release

2900d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4ea08671d505a013eaf38707d49c70dfd61331a5c2faa053cf833dfffa96e229?d=identicon)[SecureSubmit](/maintainers/SecureSubmit)

---

Top Contributors

[![slogsdon](https://avatars.githubusercontent.com/u/647624?v=4)](https://github.com/slogsdon "slogsdon (84 commits)")[![SenthilKumar-86](https://avatars.githubusercontent.com/u/24315255?v=4)](https://github.com/SenthilKumar-86 "SenthilKumar-86 (64 commits)")[![markhagan](https://avatars.githubusercontent.com/u/963600?v=4)](https://github.com/markhagan "markhagan (4 commits)")[![dthawkins](https://avatars.githubusercontent.com/u/550589?v=4)](https://github.com/dthawkins "dthawkins (3 commits)")[![rerwin03](https://avatars.githubusercontent.com/u/149521269?v=4)](https://github.com/rerwin03 "rerwin03 (1 commits)")[![scarman01](https://avatars.githubusercontent.com/u/35737376?v=4)](https://github.com/scarman01 "scarman01 (1 commits)")

---

Tags

paymentgatewaypaymerchantomnipayheartland

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/hps-omnipay-heartland/health.svg)

```
[![Health](https://phpackages.com/badges/hps-omnipay-heartland/health.svg)](https://phpackages.com/packages/hps-omnipay-heartland)
```

###  Alternatives

[lokielse/omnipay-alipay

Alipay gateway for Omnipay payment processing library

586422.8k11](/packages/lokielse-omnipay-alipay)[omnipay/mollie

Mollie driver for the Omnipay payment processing library

631.8M10](/packages/omnipay-mollie)[sudiptpa/omnipay-nabtransact

National Australia Bank (NAB) Transact driver for the Omnipay payment processing library.

1019.5k](/packages/sudiptpa-omnipay-nabtransact)[lucassmacedo/omnipay-mercadopago

MercadoPago gateway for OmniPay

155.4k](/packages/lucassmacedo-omnipay-mercadopago)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
