laravel-omnipay/laravel-omnipay

Integerates Omnipay with Laravel and provides an easy configuration.

Omnipay for Laravel 5 & Lumen

, _(*1)

Integrates the Omnipay PHP library with Laravel 5.6 via a ServiceProvider to make Configuring multiple payment tunnels a breeze!, _(*2)

Laravel 4 Support

For Laravel 4 see the version 1.x tree, _(*3)

Now using Omnipay 3.0

Version 2.0 and onwards has been updated to use Omnipay 3.0., _(*4)

Version 2.2 and onwards is using Omnipay 2.5, _(*5)

Version 2.3 and onwards supports Laravel 5.4, _(*6)

Composer Configuration

Include the laravel-omnipay package as a dependency in your composer.json:, _(*7)

"laravel-omnipay/laravel-omnipay": "3.*"

Note: You don't need to include the omnipay/common in your composer.json - it is a requirement of the laravel-omnipay package., _(*8)

Omnipay recently went refactoring that made it so that each package is now a seperate repository. The omnipay/common package includes the core framework. You will then need to include each gateway as you require. For example:, _(*9)

"omnipay/eway": "*"

Alternatively you can include every gateway by requring:, _(*10)

"omnipay/omnipay": "*"

Note: this requires a large amount of composer work as it needs to fetch each seperate repository. This is not recommended., _(*11)

Installation

Run composer install to download the dependencies., _(*12)

Laravel 5

Add a ServiceProvider to your providers array in config/app.php:, _(*13)

'providers' => [

    'Ignited\LaravelOmnipay\LaravelOmnipayServiceProvider',

]

Add the Omnipay facade to your facades array:, _(*14)

    'Omnipay' => 'Ignited\LaravelOmnipay\Facades\OmnipayFacade',

Finally, publish the configuration files:, _(*15)

php artisan vendor:publish --provider="Ignited\LaravelOmnipay\LaravelOmnipayServiceProvider" --tag=config

Lumen

For Lumen add the following in your bootstrap/app.php, _(*16)

$app->register(Ignited\LaravelOmnipay\LumenOmnipayServiceProvider::class);

Copy the laravel-omnipay.php file from the config directory to config/laravel-omnipay.php, _(*17)

And also add the following to bootstrap/app.php, _(*18)

$app->configure('laravel-omnipay');

Configuration

Once you have published the configuration files, you can add your gateway options to the config file in config/laravel-omnipay.php., _(*19)

PayPal Express Example

Here is an example of how to configure password, username and, signature with paypal express checkout driver, _(*20)

...
'gateways' => [
    'paypal' => [
        'driver'  => 'PayPal_Express',
        'options' => [
            'username'  => env( 'OMNIPAY_PAYPAL_EXPRESS_USERNAME', '' ),
            'password'  => env( 'OMNIPAY_PAYPAL_EXPRESS_PASSWORD', '' ),
            'signature' => env( 'OMNIPAY_PAYPAL_EXPRESS_SIGNATURE', '' ),
            'solutionType' => env( 'OMNIPAY_PAYPAL_EXPRESS_SOLUTION_TYPE', '' ),
            'landingPage'    => env( 'OMNIPAY_PAYPAL_EXPRESS_LANDING_PAGE', '' ),
            'headerImageUrl' => env( 'OMNIPAY_PAYPAL_EXPRESS_HEADER_IMAGE_URL', '' ),
            'brandName' =>  'Your app name',
            'testMode' => env( 'OMNIPAY_PAYPAL_TEST_MODE', true )
        ]
    ],
]
...

Usage

$cardInput = [
    'number'      => '4444333322221111',
    'firstName'   => 'MR. WALTER WHITE',
    'expiryMonth' => '03',
    'expiryYear'  => '16',
    'cvv'         => '333',
];

$card = Omnipay::creditCard($cardInput);
$response = Omnipay::purchase([
    'amount'    => '100.00',
    'returnUrl' => 'http://bobjones.com/payment/return',
    'cancelUrl' => 'http://bobjones.com/payment/cancel',
    'card'      => $cardInput
])->send();

dd($response->getMessage());

This will use the gateway specified in the config as default., _(*21)

However, you can also specify a gateway to use., _(*22)

Omnipay::setGateway('eway');

$response = Omnipay::purchase([
    'amount' => '100.00',
    'card'   => $cardInput
])->send();

dd($response->getMessage());

In addition you can take an instance of the gateway., _(*23)

$gateway = Omnipay::gateway('eway');