Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ignited/laravel-omnipay
Omnipay for Laravel & Lumen
https://github.com/ignited/laravel-omnipay
Last synced: 5 days ago
JSON representation
Omnipay for Laravel & Lumen
- Host: GitHub
- URL: https://github.com/ignited/laravel-omnipay
- Owner: ignited
- License: mit
- Created: 2013-10-18T00:10:37.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T12:23:36.000Z (9 months ago)
- Last Synced: 2024-12-30T04:02:50.750Z (13 days ago)
- Language: PHP
- Homepage:
- Size: 63.5 KB
- Stars: 511
- Watchers: 17
- Forks: 100
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
- awesome-laravel-framework - Omnipay for Laravel - Integrate the [Omnipay](https://github.com/thephpleague/omnipay) PHP library (Popular Packages)
- awesome-laravel - Omnipay for Laravel - Integración de [Omnipay](https://github.com/thephpleague/omnipay) (Paquetes utiles)
- laravel-awesome - Omnipay for Laravel - Integrate the [Omnipay](https://github.com/thephpleague/omnipay) PHP library (Popular Packages)
- awesome-laravel - Omnipay for Laravel - Integrate the [Omnipay](https://github.com/thephpleague/omnipay) PHP library (Popular Packages)
README
Omnipay for Laravel & Lumen
==============
[](https://packagist.org/packages/ignited/laravel-omnipay)
[](https://github.com/ignited/laravel-omnipay/releases)
Integrates the [Omnipay](https://github.com/adrianmacneil/omnipay) PHP library with Laravel to make Configuring multiple payment tunnels a breeze!
## Installation
Include the laravel-omnipay package as a dependency in your `composer.json`:
composer require ignited/laravel-omnipay "3.*"
**Note:** You don't need to include the `omnipay/common` in your composer.json - it has already been included `laravel-omnipay`.
### Install Required Providers
Now just include each gateway as you require, to included PayPal for example:
composer require omnipay/paypal "3.*"
Alternatively you can include every gateway by the following:
composer require omnipay/omnipay "3.*"
**Note:** this requires a large amount of composer work as it needs to fetch each seperate repository. This is not recommended.
## Configuration
You can publish the configuration files using the `vendor:publish` command.
```
php artisan vendor:publish --provider="Ignited\LaravelOmnipay\LaravelOmnipayServiceProvider" --tag=config
```
Once you have published the configuration files, you can add your gateway options to the config file in `config/laravel-omnipay.php`.
#### PayPal Express Example
Here is an example of how to configure password, username and, signature with paypal express checkout driver
```php
...
'gateways' => [
'paypal' => [
'driver' => 'PayPal_Express',
'options' => [
'username' => 'coolusername',
'password' => 'strongpassword',
'signature' => '',
'solutionType' => '',
'landingPage' => '',
'headerImageUrl' => '',
'brandName' => 'Your app name',
'testMode' => true
]
],
]
...
```
## Usage
```php
$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`.
However, you can also specify a gateway to use.
```php
Omnipay::setGateway('paypal');
$response = Omnipay::purchase([
'amount' => '100.00',
'card' => $cardInput
])->send();
dd($response->getMessage());
```
In addition you can make an instance of the gateway.
```php
$gateway = Omnipay::gateway('paypal');
```
## Installation on Other Frameworks
### Lumen
For `Lumen` add the following in your bootstrap/app.php
```php
$app->register(Ignited\LaravelOmnipay\LumenOmnipayServiceProvider::class);
```
Copy the laravel-omnipay.php file from the config directory to config/laravel-omnipay.php
And also add the following to bootstrap/app.php
```php
$app->configure('laravel-omnipay');
```
## Guzzle
If you are using Guzzle 6 you need to require the following package.
composer require php-http/guzzle6-adapter
Guzzle 7 now implements a PSR http client compliant adapter. So there is no need to include this.
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).