fotografde/omnipay-checkoutcom driver for the Omnipay payment processing library

2.1.1 2017-09-12 15:25 UTC

This package is auto-updated.

Last update: 2024-02-17 07:14:23 UTC

README driver for the Omnipay PHP payment processing library

Build Status Latest Stable Version Total Downloads License

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


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

    "require": {
        "fotografde/omnipay-checkoutcom": "~2.0"

And run composer to update your dependencies:

$ curl -s | php
$ php composer.phar update

Basic Usage

The following gateways are provided by this package:

For general usage instructions, please see the main Omnipay repository.


Currently this package provides implementation of 2 workflows:

1. Authorize payment and then capture

The integration is fairly straight forward. Essentially you just pass the order data and receive a payment token, which you can use in the checkout.js payment form. After your customer has entered his data, you'll receive another token, which you can use to capture the payment.

Start by following the standard JS guide here:

Full documentation of the API can be found here:

First Authorize:

$response = $gateway->purchase(['amount' => $amount, 'currency' => $currency])->send();
if ($response->isRedirect()) {
    $token = $response->getTransactionReference();

Then Capture:

$response = $gateway->completePurchase(['amount' => $amount, 'transactionReference' => $token])->send();
if ($response->isSuccessful()) {
    // approve Order

2. Payment with card token (card token purchase)

$response = $gateway->cardTokenPurchase([
    'amount' => $amount, 
    'currency' => $currency, 
    'email' => '', 
    'cardToken' => 'some_token', 
    'description' => 'some nice description'

Note that amount, currency, email and cardToken are required fields here.


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.