PHPackages                             pickupman/omnipay-hrh - 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. pickupman/omnipay-hrh

ActiveLibrary[Payment Processing](/categories/payments)

pickupman/omnipay-hrh
=====================

Omnipay gateway for High Risk Holdings

06PHP

Since Aug 15Pushed 7y ago1 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

Omnipay: Hrh
============

[](#omnipay-hrh)

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

[![Latest Stable Version](https://camo.githubusercontent.com/8f9392d17f62a5d60603babdf02fa1a3b82faff7eef2a522b3e297fe5c79d128/68747470733a2f2f706f7365722e707567782e6f72672f7069636b75706d616e2f6f6d6e697061792d4872682f76657273696f6e2e706e67)](https://packagist.org/packages/pickupman/omnipay-hrh)[![Total Downloads](https://camo.githubusercontent.com/abf52e0b6645817d63664a845610b18f0f76a85ca82f536f4b311eaa8e97b5b6/68747470733a2f2f706f7365722e707567782e6f72672f7069636b75706d616e2f6f6d6e697061792d4872682f642f746f74616c2e706e67)](https://packagist.org/packages/pickupman/omnipay-hrh)

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

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

[](#installation)

Omnipay is installed via [Composer](http://getcomposer.org/). To install, simply add it to your `composer.json` file:

```
{
    "require": {
        "pickupman/omnipay-hrh": "~1.0"
    }
}
```

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:

- High Risk Holdings (Hrh)

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

Purchase / Sale
---------------

[](#purchase--sale)

For charging a card you may do the following

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setUsername('username');
$gateway->setPassword('password');

// Example card data
$card = new Omnipay\Common\CreditCard([
    'firstName'       => 'John',
    'lastName'        => 'Doe',
    'billingAddress1' => '888 Main',
    'billingZip'      => '77777',
    'billingCity'     => 'City',
    'billingState'    => 'State',
    'billingPostcode' => 'Zip',
    'number'          => '4111111111111111',
    'expiryMonth'     => '6',
    'expiryYear'      => '2016',
    'cvv'             => '123'
]);

$response = $gateway->purchase(
		         [
			         'card'                 => $card,
			         'amount'               => '10.00',
			         'clientIp'             => $_SERVER['REMOTE_ADDR'],
			         'transactionReference' => '1',
		         ]
		     )->send();

if ( $response->isSuccessful() ) {
	// Continue processing
	$transactionID = $response->getTransactionReference();
}
```

Refund / Credit
---------------

[](#refund--credit)

In order to process a refund, you must pass the originating transaction id returned by the gateway

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setUsername('username');
$gateway->setPassword('password');

$response = $gateway->refund(
		         [
			         'amount'               => '10.00',
			         'transactionReference' => 'original transactionid',
		         ]
		     )->send();

if ( $response->isSuccessful() ) {
	// Continue processing
	$transactionID = $response->getTransactionReference();
}
```

Void
----

[](#void)

To void an existing transaction, you must pass the originating transaction id returned by the gateway

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setUsername('username');
$gateway->setPassword('password');

$response = $gateway->void(
		         [
			         'transactionReference' => 'original transactionid',
		         ]
		     )->send();

if ( $response->isSuccessful() ) {
	// Continue processing
	$transactionID = $response->getTransactionReference();
}
```

Authorize
---------

[](#authorize)

You can authorize a credit card to verify funds, and then process the amount later.

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setUsername('username');
$gateway->setPassword('password');

// Example card data
$card = new Omnipay\Common\CreditCard([
    'firstName'       => 'John',
    'lastName'        => 'Doe',
    'billingAddress1' => '888 Main',
    'billingZip'      => '77777',
    'billingCity'     => 'City',
    'billingState'    => 'State',
    'billingPostcode' => 'Zip',
    'number'          => '4111111111111111',
    'expiryMonth'     => '6',
    'expiryYear'      => '2016',
    'cvv'             => '123'
]);

$response = $gateway->authorize(
		         [
			         'card'                 => $card,
			         'amount'               => '10.00',
			         'transactionReference' => 'order id or other unique value',
		         ]
		     )->send();

if ( $response->isSuccessful() ) {
	// Continue processing
	$transactionID = $response->getTransactionReference(); // Use this value later to capture
}
```

Capture
-------

[](#capture)

Use a capture, to charge a card after retrieving an authorization

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setUsername('username');
$gateway->setPassword('password');

$response = $gateway->capture(
		         [
			         'amount'               => '10.00',
			         'transactionReference' => 'order id or other unique value',
		         ]
		     )->send();

if ( $response->isSuccessful() ) {
	// Continue processing
	$transactionID = $response->getTransactionReference(); // Use this value later to capture
}
```

Test Mode
---------

[](#test-mode)

This feature will *NOT* turn on test mode for your account. Test mode must be enabled or disabled from your Hrh control panel. All transactions processed on a live account will be charged.

If you would like to use the default testing credentials from Hrh, please initialize the gateway with

```
$gateway = Omnipay\Omnipay::create('Hrh');
$gateway->setTestMode(true); // Automatically sets default testing gateway username and password
```

Any transactions processed with testMode(true) will not be charged, *OR* shown in your control panel. This method will automatically apply the testing username and password for the Hrh gateway.

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 anouncements, 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/pickupman/omnipay-hrh/issues), or better yet, fork the library and submit a pull request.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/52ba696c9ae39e63cbb1dda630bf921b16118f123b0fe62c7d41ddd0b4526e3b?d=identicon)[pickupman](/maintainers/pickupman)

---

Top Contributors

[![pickupman](https://avatars.githubusercontent.com/u/1220279?v=4)](https://github.com/pickupman "pickupman (4 commits)")

### Embed Badge

![Health badge](/badges/pickupman-omnipay-hrh/health.svg)

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

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy

Dummy driver for the Omnipay payment processing library

271.2M33](/packages/omnipay-dummy)

PHPackages © 2026

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