Vindicia driver for the Omnipay payment processing library

v2.24.0 2021-09-29 18:58 UTC


Vindicia driver for the Omnipay PHP payment processing library

Build Status Latest Stable Version Total Downloads

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

Vindicia is a payment services provider founded in Redwood City, CA in 2003 and focused on subscription billing. This driver interfaces with Cashbox, their subscription billing platform.


Omnipay is installed via Composer. 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 | 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

The following gateways are provided by this package:

  • Vindicia
  • Vindicia_PayPal (Vindicia's PayPal Express implementation)
  • Vindicia_HOA (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

$gateway = \Omnipay\Omnipay::create('Vindicia');

$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

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

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.


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.

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.