Accept payments via FreeKassa (free-kassa.ru) using this Laravel framework package (Laravel).
- receive payments, adding just the two callbacks
Require this package with composer.
composer require maksa988/laravel-freekassa
If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php
Maksa988\FreeKassa\FreeKassaServiceProvider::class,
Add the FreeKassa
facade to your facades array:
'FreeKassa' => Maksa988\FreeKassa\Facades\FreeKassa::class,
Copy the package config to your local config with the publish command:
php artisan vendor:publish --provider="Maksa988\FreeKassa\FreeKassaServiceProvider"
Once you have published the configuration files, please edit the config file in config/freekassa.php
.
- Create an account on free-kassa.ru
- Add your project, copy the
project_id
,secret_key
andsecret_key_second
params and paste intoconfig/freekassa.php
- After the configuration has been published, edit
config/freekassa.php
- Set the callback static function for
searchOrder
andpaidOrder
- Create route to your controller, and call
FreeKassa::handle
method
- Generate a payment url or get redirect:
$amount = 100; // Payment`s amount
$url = FreeKassa::getPayUrl($amount, $order_id);
$redirect = FreeKassa::redirectToPayUrl($amount, $order_id);
You can add custom fields to your payment:
$rows = [
'time' => Carbon::now(),
'info' => 'Local payment'
];
$url = FreeKassa::getPayUrl($amount, $order_id, $email, $phone, $rows);
$redirect = FreeKassa::redirectToPayUrl($amount, $order_id, $email, $phone, $rows);
$email
and $phone
can be null.
- Process the request from FreeKassa:
FreeKassa::handle(Request $request)
You must define callbacks in config/freekassa.php
to search the order and save the paid order.
'searchOrder' => null // FreeKassaController@searchOrder(Request $request)
'paidOrder' => null // FreeKassaController@paidOrder(Request $request, $order)
The process scheme:
- The request comes from
free-kassa.ru
GET
/POST
http://yourproject.com/freekassa/result
(with params). - The function
FreeKassaController@handlePayment
runs the validation process (auto-validation request params). - The method
searchOrder
will be called (seeconfig/freekassa.php
searchOrder
) to search the order by the unique id. - If the current order status is NOT
paid
in your database, the methodpaidOrder
will be called (seeconfig/freekassa.php
paidOrder
).
Add the route to routes/web.php
:
Route::get('/freekassa/result', 'FreeKassaController@handlePayment');
Note: don't forget to save your full route url (e.g. http://example.com/freekassa/result ) for your project on free-kassa.ru.
Create the following controller: /app/Http/Controllers/FreeKassaController.php
:
class FreeKassaController 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 FreeKassa::handle($request);
}
}
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please send me an email at [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.