PHPackages                             vimeo/omnipay-bluesnap - 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. vimeo/omnipay-bluesnap

ActiveLibrary[Payment Processing](/categories/payments)

vimeo/omnipay-bluesnap
======================

BlueSnap driver for the Omnipay payment processing library

v3.4.0(4y ago)4148.2k6[1 PRs](https://github.com/vimeo/omnipay-bluesnap/pulls)MITPHP

Since Aug 10Pushed 1y ago11 watchersCompare

[ Source](https://github.com/vimeo/omnipay-bluesnap)[ Packagist](https://packagist.org/packages/vimeo/omnipay-bluesnap)[ Docs](https://github.com/vimeo/omnipay-bluesnap)[ RSS](/packages/vimeo-omnipay-bluesnap/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (9)Dependencies (3)Versions (14)Used By (0)

Omnipay: BlueSnap
=================

[](#omnipay-bluesnap)

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

*NOTE: At this time, this driver only provides full support for BlueSnap's [BuyNow Hosted Checkout](https://home.bluesnap.com/features-tools/flexible-integration-options/hosted-checkout/) product. But you can add support for more parts of the API!*

[![Build Status](https://camo.githubusercontent.com/8febc6484eb31df407bffc2bcb38bcbc5ee885e589053fb722bf19313b7438fb/68747470733a2f2f7472617669732d63692e6f72672f76696d656f2f6f6d6e697061792d626c7565736e61702e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/vimeo/omnipay-bluesnap)[![Latest Stable Version](https://camo.githubusercontent.com/6d1458e524a7d08189a06e7ad072f5e090ac8d717b1444993fee900a1211cd1d/68747470733a2f2f706f7365722e707567782e6f72672f76696d656f2f6f6d6e697061792d626c7565736e61702f76657273696f6e2e706e67)](https://packagist.org/packages/vimeo/omnipay-bluesnap)[![Total Downloads](https://camo.githubusercontent.com/49830dfbc3afcc4196ad483d910d23f24987578a25f9f258ff173c87a308c3c8/68747470733a2f2f706f7365722e707567782e6f72672f76696d656f2f6f6d6e697061792d626c7565736e61702f642f746f74616c2e706e67)](https://packagist.org/packages/vimeo/omnipay-bluesnap)

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

[BlueSnap](https://bluesnap.com/) is a payment services provider based in Waltham, Massachusetts. In addition to traditional payment gateway services, they provide hosted solutions and a range of global payment methods.

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

[](#installation)

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

```
{
    "require": {
        "vimeo/omnipay-bluesnap": "2.0.*"
    }
}
```

And run composer to update your dependencies:

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

```

*(Note that we recommend pinning the minor version. While `v2.*` will remain fully compatible with Omnipay 2, features added in addition to the base Omnipay features, such as subscriptions, may have breaking changes in a minor version bump.)*

Basic Usage
-----------

[](#basic-usage)

The following gateways are provided by this package:

- BlueSnap\_HostedCheckout, for [BlueSnap's BuyNow Hosted Checkout](https://support.bluesnap.com/v2.2.7/docs/intro-extended-api) page.

Some features of the following gateways are provided, but not enough to use them on their own. Feel free to contribute!

- BlueSnap, for BlueSnap's traditional [Payment API](https://developers.bluesnap.com/v8976-JSON/docs). This gateway is almost entirely unimplemented at this time, except for parts of the [Reporting API](https://developers.bluesnap.com/v8976-Tools/docs).
- BlueSnap\_Extended, for the BlueSnap [Extended Payment API](https://support.bluesnap.com/v2.2.7/docs/intro-extended-api). This is the API you should use if you're hosting your product catalog with BlueSnap. It powers the BuyNow Hosted Checkout, as well as other products. Enough of this API is implemented in this driver to power the BlueSnap\_HostedCheckout gateway.

### Simple Example

[](#simple-example)

```
// Set up the gateway
$gateway = \Omnipay\Omnipay::create('BlueSnap_HostedCheckout');
$gateway->setUsername('your_username');
$gateway->setPassword('y0ur_p4ssw0rd');
$gateway->setTestMode(false);

// Start the purchase process
$purchaseResponse = $gateway->purchase(array(
    'storeReference' => '12345',
    'planReference' => '1234567',
    'currency' => 'USD'
))->send();

if ($purchaseResponse->isSuccessful()) {
    $purchaseResponse->redirect();
} else {
    // error handling
}

// Now the user is filling out info on BlueSnap's hosted checkout page. Then they get
// redirected back to your site. If you set parameters in the return/callback URL, you
// can access those here.

// Once the transaction has been captured, you'll receive an IPN callback, which you can
// handle like so:

$ipnCallback = $gateway->parseIPNCallback($_SERVER['REQUEST_URI']);
if ($ipnCallback->isCharge()) {
    echo 'Transaction reference: ' . $ipnCallback->getTransactionReference() . PHP_EOL;
    echo 'Amount: ' . $ipnCallback->getAmount() . PHP_EOL;
    echo 'Currency: ' . $ipnCallback->getCurrency() . PHP_EOL;
} elseif ($ipnCallback->isCancellation()) {
    // etc.
}
```

More documentation and examples are provided in the Gateway source files.

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

Test Mode
---------

[](#test-mode)

BlueSnap accounts have a separate username and password for test mode. There is also a separate test mode endpoint, which this library will use when set to test mode.

Support
-------

[](#support)

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

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.

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 50% 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 ~198 days

Recently: every ~82 days

Total

9

Last Release

1611d ago

Major Versions

v2.1.0 → v3.0.02021-01-20

### Community

Maintainers

![](https://www.gravatar.com/avatar/d1e918e2deb48869e4ad182fdb27960c332b694b689063c6981688861315f9c6?d=identicon)[nickyr](/maintainers/nickyr)

---

Top Contributors

[![nickyr](https://avatars.githubusercontent.com/u/1389687?v=4)](https://github.com/nickyr "nickyr (7 commits)")[![jcmanzo](https://avatars.githubusercontent.com/u/3589097?v=4)](https://github.com/jcmanzo "jcmanzo (4 commits)")[![sungcheng](https://avatars.githubusercontent.com/u/6721106?v=4)](https://github.com/sungcheng "sungcheng (2 commits)")[![hannahlorane](https://avatars.githubusercontent.com/u/20115371?v=4)](https://github.com/hannahlorane "hannahlorane (1 commits)")

---

Tags

paymentgatewaypaymerchantomnipaybluesnap

### Embed Badge

![Health badge](/badges/vimeo-omnipay-bluesnap/health.svg)

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

###  Alternatives

[lokielse/omnipay-alipay

Alipay gateway for Omnipay payment processing library

587421.0k11](/packages/lokielse-omnipay-alipay)[sudiptpa/omnipay-nabtransact

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

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

MercadoPago gateway for OmniPay

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

PHPackages © 2026

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