Fat Zebra / Paystream driver for the Omnipay PHP payment processing library
PHP Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
tests
.gitignore
.styleci.yml
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
composer.json
makedoc.sh
phpunit.xml.dist
runtests.sh

README.md

omnipay-fatzebra

Fat Zebra / Paystream driver for the Omnipay PHP payment processing library

Build Status StyleCI

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

Fat Zebra and Paystream are Australian online payments processing providers with equivalent REST APIs.

Installation

Omnipay is installed via Composer. To install, simply add it to your composer.json file:

{
    "require": {
        "delatbabel/omnipay-fatzebra": "~2.0"
    }
}

And run composer to update your dependencies:

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

Basic Usage

The following transactions are provided by this package via the REST API:

  • Create a purchase
  • Retrieve a purchase
  • Refund a purchase
  • Tokenizing a card and using a stored token

For general usage instructions, please see the main Omnipay repository. There are also examples in the class API documentation.

TODO

  • Recurring Payments
  • Hosted Payments

Unit Testing

Travis-CI runs the phpcs and phpunit test jobs. The current status can be seen here.

API Documentation

You can build the API documentation after running composer update, by using this command (on Linux/Unix systems):

./makedoc.sh

The API documentation will be built in documents/main in HTML format.

The API documentation is also hosted here

Support

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 anouncements, discuss ideas for the project, or ask more detailed questions, there is also a mailing list which you can subscribe to.

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.

Release Notes

Version 2.1 includes the following changes:

  • When making a purchase set the transactionId to the merchant generated transaction reference instead of setting transactionReference. This alings with the general Omnipay standards.
  • Failed transactions are now detected succesfully.
  • An error message from the response data is returned if no errors are returned separately.
  • The error code from the response data is returned as the result of getCode() instead of just the HTTP status code.