Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maksa988/laravel-unitpay
Laravel payments for Laravel
https://github.com/maksa988/laravel-unitpay
accept-payments laravel laravel-5-package laravel-payments laravel-unitpay unitpay
Last synced: 2 days ago
JSON representation
Laravel payments for Laravel
- Host: GitHub
- URL: https://github.com/maksa988/laravel-unitpay
- Owner: maksa988
- License: mit
- Created: 2019-01-15T11:46:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-02T17:20:44.000Z (over 3 years ago)
- Last Synced: 2024-11-10T16:35:39.161Z (7 days ago)
- Topics: accept-payments, laravel, laravel-5-package, laravel-payments, laravel-unitpay, unitpay
- Language: PHP
- Size: 38.1 KB
- Stars: 13
- Watchers: 3
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel payment processor package for UnitPay gateway
[](https://packagist.org/packages/maksa988/laravel-unitpay)
[](https://travis-ci.org/maksa988/laravel-unitpay)
[](https://github.styleci.io/repos/165841601)
[](https://www.codefactor.io/repository/github/maksa988/laravel-unitpay)
[](https://packagist.org/packages/maksa988/laravel-unitpay)
[](https://packagist.org/packages/maksa988/laravel-unitpay)
Accept payments via UnitPay ([unitpay.ru](https://unitpay.ru/)) using this Laravel framework package ([Laravel](https://laravel.com)).
- receive payments, adding just the two callbacks
#### Laravel >= 8.*, PHP >= 7.3
> To use the package for Laravel 7.* use the [3.x](https://github.com/maksa988/laravel-unitpay/tree/3.x) branch
> To use the package for Laravel 6.* use the [2.x](https://github.com/maksa988/laravel-unitpay/tree/2.x) branch
> To use the package for Laravel 5.* use the [1.x](https://github.com/maksa988/laravel-unitpay/tree/1.x) branch
## Installation
Require this package with composer.
``` bash
composer require "maksa988/laravel-unitpay"
```
If you don't use auto-discovery, add the ServiceProvider to the providers array in `config/app.php`
```php
Maksa988\UnitPay\UnitPayServiceProvider::class,
```
Add the `UnitPay` facade to your facades array:
```php
'UnitPay' => Maksa988\UnitPay\Facades\UnitPay::class,
```
Copy the package config to your local config with the publish command:
``` bash
php artisan vendor:publish --provider="Maksa988\UnitPay\UnitPayServiceProvider"
```
## Configuration
Once you have published the configuration files, please edit the config file in `config/unitpay.php`.
- Create an account on [unitpay.ru](http://unitpay.ru)
- Add your project, copy the `public_key`, `secret_key` params and paste into `config/unitpay.php`
- After the configuration has been published, edit `config/unitpay.php`
- Set the callback static function for `searchOrder` and `paidOrder`
- Create route to your controller, and call `UnitPay::handle` method
## Usage
1) Generate a payment url or get redirect:
```php
$amount = 100; // Payment`s amount
$email = "[email protected]"; // Your customer`s email
$description = "Test payment";
//
$url = UnitPay::getPayUrl($amount, $order_id, $email, $description, $currency);
$redirect = UnitPay::redirectToPayUrl($amount, $order_id, $email, $description, $currency);
```
2) Process the request from UnitPay:
``` php
UnitPay::handle(Request $request)
```
## Important
You must define callbacks in `config/unitpay.php` to search the order and save the paid order.
``` php
'searchOrder' => null // UnitPayController@searchOrder(Request $request)
```
``` php
'paidOrder' => null // UnitPayController@paidOrder(Request $request, $order)
```
## Example
The process scheme:
1. The request comes from `unitpay.ru` `GET` `http://yourproject.com/unitpay/result` (with params).
2. The function`UnitPayController@handlePayment` runs the validation process (auto-validation request params).
3. The method `searchOrder` will be called (see `config/unitpay.php` `searchOrder`) to search the order by the unique id.
4. If the current order status is NOT `paid` in your database, the method `paidOrder` will be called (see `config/unitpay.php` `paidOrder`).
Add the route to `routes/web.php`:
``` php
Route::get('/unitpay/result', 'UnitPayController@handlePayment');
```
> **Note:**
don't forget to save your full route url (e.g. http://example.com/unitpay/result ) for your project on [unitpay.ru](unitpay.ru).
Create the following controller: `/app/Http/Controllers/UnitPayController.php`:
``` php
class UnitPayController extends Controller
{
/**
* Search the order in your database and return that order
* to paidOrder, if status of your order is 'paid'
*
* @param Request $request
* @param $order_id
* @return bool|mixed
*/
public function searchOrder(Request $request, $order_id)
{
$order = Order::where('id', $order_id)->first();
if($order) {
$order['_orderSum'] = $order->sum;
// If your field can be `paid` you can set them like string
$order['_orderStatus'] = $order['status'];
// Else your field doesn` has value like 'paid', you can change this value
$order['_orderStatus'] = ('1' == $order['status']) ? 'paid' : false;
return $order;
}
return false;
}
/**
* When paymnet is check, you can paid your order
*
* @param Request $request
* @param $order
* @return bool
*/
public function paidOrder(Request $request, $order)
{
$order->status = 'paid';
$order->save();
//
return true;
}
/**
* Start handle process from route
*
* @param Request $request
* @return mixed
*/
public function handlePayment(Request $request)
{
return UnitPay::handle($request);
}
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please send me an email at [email protected] instead of using the issue tracker.
## Credits
- [Maksa988](https://github.com/maksa988)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.