barryvdh / laravel-omnipay
Omnipay Service Provider for Laravel
Installs: 185 699
Dependents: 0
Suggesters: 0
Security: 0
Stars: 168
Watchers: 8
Forks: 46
Open Issues: 9
Requires
- illuminate/support: ^5|^6|^7|^8|^9.0
- league/omnipay: ~3.0
README
This is a package to integrate Omnipay with Laravel. You can use it to easily manage your configuration, and use the Facade to provide shortcuts to your gateway.
Installation
Require this package with composer.
$ composer require barryvdh/laravel-omnipay
Pre Laravel 5.5: After updating composer, add the ServiceProvider to the providers array in config/app.php
'Barryvdh\Omnipay\ServiceProvider',
You need to publish the config for this package. A sample configuration is provided. The defaults will be merged with gateway specific configuration.
$ php artisan vendor:publish --provider=Barryvdh\Omnipay\ServiceProvider
To use the Facade (Omnipay::purchase()
instead of App::make(
omnipay)->purchase()
), add that to the facades array.
'Omnipay' => 'Barryvdh\Omnipay\Facade',
When calling the Omnipay facade/instance, it will create the default gateway, based on the configuration.
You can change the default gateway by calling Omnipay::setDefaultGateway('My\Gateway')
.
You can get a different gateway by calling Omnipay::gateway('My\Cass')
Examples
$params = [ 'amount' => $order->amount, 'issuer' => $issuerId, 'description' => $order->description, 'returnUrl' => URL::action('PurchaseController@return', [$order->id]), ]; $response = Omnipay::purchase($params)->send(); if ($response->isSuccessful()) { // payment was successful: update database print_r($response); } elseif ($response->isRedirect()) { // redirect to offsite payment gateway return $response->getRedirectResponse(); } else { // payment failed: display message to customer echo $response->getMessage(); }
Besides the gateway calls, there is also a shortcut for the creditcard:
$formInputData = [ 'firstName' => 'Bobby', 'lastName' => 'Tables', 'number' => '4111111111111111', ]; $card = Omnipay::CreditCard($formInputData);