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

ActiveLibrary[Payment Processing](/categories/payments)

vimeo/omnipay-vindicia
======================

Vindicia driver for the Omnipay payment processing library

v2.41.0(1y ago)3154.9k9[7 issues](https://github.com/vimeo/omnipay-vindicia/issues)[1 PRs](https://github.com/vimeo/omnipay-vindicia/pulls)MITPHP

Since Oct 17Pushed 1y ago11 watchersCompare

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

READMEChangelog (10)Dependencies (4)Versions (134)Used By (0)

Omnipay: Vindicia
=================

[](#omnipay-vindicia)

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

[![Latest Stable Version](https://camo.githubusercontent.com/4ade863d9acae0aeaafe08d8eaeb72d69a72da1772eb6fc3e4dac8f16dab3ccf/68747470733a2f2f706f7365722e707567782e6f72672f76696d656f2f6f6d6e697061792d76696e64696369612f76657273696f6e2e706e67)](https://packagist.org/packages/vimeo/omnipay-vindicia)[![Total Downloads](https://camo.githubusercontent.com/c76e201ec010d5289daf4e282ae8f5d3f4ef7947e532f3523f6c36277dfdebfc/68747470733a2f2f706f7365722e707567782e6f72672f76696d656f2f6f6d6e697061792d76696e64696369612f642f746f74616c2e706e67)](https://packagist.org/packages/vimeo/omnipay-vindicia)

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

[Vindicia](https://vindicia.com/) is a payment services provider founded in Redwood City, CA in 2003 and focused on subscription billing. This driver interfaces with [Cashbox](https://www.vindicia.com/solutions/vindicia-cashbox), their subscription billing platform.

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

[](#installation)

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

```
{
    "require": {
        "vimeo/omnipay-vindicia": "2.6.*"
    }
}
```

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:

- [Vindicia](https://vindicia.com/)
- Vindicia\_PayPal (Vindicia's PayPal Express implementation)
- Vindicia\_HOA ([Hosted Order Automation](https://www.vindicia.com/resources/data-sheets/hosted-order-automation), Vindicia's solution for minimizing your PCI compliance burden)

**NOTE:** Unlike many gateways, Vindicia requires that every purchase have a corresponding customer. Therefore, the `customerId` or `customerReference` must be provided for every authorize or purchase request. If you pass a `customerId` that does not exist, Vindicia will create the customer object for you as part of the same request. (A `customerReference` that does not exist is an error.)

### Simple Example

[](#simple-example)

```
$gateway = \Omnipay\Omnipay::create('Vindicia');
$gateway->setUsername('your_username');
$gateway->setPassword('y0ur_p4ssw0rd');
$gateway->setTestMode(false);

$response = $gateway->purchase(array(
    'amount' => '9.95',
    'currency' => 'USD',
    'customerId' => '123456', // if the customer does not exist, it will be created
    'card' => array(
        'number' => '5555555555554444',
        'expiryMonth' => '01',
        'expiryYear' => '2020',
        'cvv' => '123'
    ),
    'paymentMethodId' => 'cc-123456' // this ID will be assigned to the card
))->send();

if ($response->isSuccessful()) {
    echo "Transaction id: " . $purchaseResponse->getTransactionId() . PHP_EOL;
    echo "Transaction reference: " . $purchaseResponse->getTransactionReference() . PHP_EOL;
}
```

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)

Vindicia 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-vindicia/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

Maintenance12

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community24

Small or concentrated contributor base

Maturity81

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 61.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 ~29 days

Recently: every ~73 days

Total

95

Last Release

718d ago

### Community

Maintainers

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

![](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 (158 commits)")[![fredespo](https://avatars.githubusercontent.com/u/13394575?v=4)](https://github.com/fredespo "fredespo (33 commits)")[![brendanpeters](https://avatars.githubusercontent.com/u/19190933?v=4)](https://github.com/brendanpeters "brendanpeters (13 commits)")[![AdmTal](https://avatars.githubusercontent.com/u/3382568?v=4)](https://github.com/AdmTal "AdmTal (13 commits)")[![jcmanzo](https://avatars.githubusercontent.com/u/3589097?v=4)](https://github.com/jcmanzo "jcmanzo (8 commits)")[![parth21shah](https://avatars.githubusercontent.com/u/1994877?v=4)](https://github.com/parth21shah "parth21shah (7 commits)")[![DanayaMel](https://avatars.githubusercontent.com/u/15119003?v=4)](https://github.com/DanayaMel "DanayaMel (6 commits)")[![ula](https://avatars.githubusercontent.com/u/46541238?v=4)](https://github.com/ula "ula (5 commits)")[![tremainedavisvimeo](https://avatars.githubusercontent.com/u/129979367?v=4)](https://github.com/tremainedavisvimeo "tremainedavisvimeo (4 commits)")[![kaylafuchs](https://avatars.githubusercontent.com/u/15958502?v=4)](https://github.com/kaylafuchs "kaylafuchs (4 commits)")[![sungcheng](https://avatars.githubusercontent.com/u/6721106?v=4)](https://github.com/sungcheng "sungcheng (3 commits)")[![pierlon](https://avatars.githubusercontent.com/u/16200219?v=4)](https://github.com/pierlon "pierlon (2 commits)")[![MelechMizrachi](https://avatars.githubusercontent.com/u/1179171?v=4)](https://github.com/MelechMizrachi "MelechMizrachi (1 commits)")

---

Tags

paymentgatewaypaymerchantomnipayvindicia

### Embed Badge

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

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

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