PayHere for Laravel

PayHere is a widely used payment gateway service in Sri Lanka. The Laravel PayHere plugin provides seamless integration of PayHere into Laravel applications, allowing developers to access all PayHere APIs easily. This package supports various payment types, making it an essential solution for anyone looking to enhance their application's payment processing capabilities.

#Main Features

• Onsite and Offsite Checkout Flows
• Dispatches events for received webhooks, managing payments, and managing subscriptions.
• Implement the PayHereCustomer interface with your User model to facilitate payments from authenticated users in your Laravel application.
• Provides a Billable trait that you can also use in your User model with methods to perform common billing tasks.
• An Intermediate RESTful API that allows for communication with the PayHere RESTful API. This is especially useful for mobile apps that need to integrate with PayHere.
• An HTML form-based API builder to help you generate the necessary HTML inputs based on your configuration and redirect your users to the payment gateway to complete the transaction.
• It also includes a built-in Filament panel, making it easy to manage payments and subscriptions right in your Laravel application.

You can install PayHere using Composer:

composer require laravel-payhere/laravel-payhere

Finally, you may run the following command to publish assets and migrations:

php artisan payhere:install

If you plan to use the PayHere panel, you should run the following command to publish the Filament assets:

php artisan filament:assets

You will need to ensure you have an account with PayHere and that you get the relevant API Keys and Merchant ID's from the PayHere portal and add them to your .env file:

PAYHERE_MERCHANT_ID=your-payhere-merchant-id
PAYHERE_MERCHANT_SECRET=-your-payhere-merchant-secret
PAYHERE_APP_ID=your-payhere-app-id
PAYHERE_APP_SECRET=your-payhere-app-secret

There are also additional environment variables for the default currency, notify url and return url allowing further customisation of the integration with the payment gateway.

#Basic Example

Here, we define a basic route for a user to checkout:

use App\Http\Controllers\Checkout;
 
Route::get('/checkout', Checkout::class);

The corresponding controller could look similar to the following:

<?php
 
namespace App\Http\Controllers;
 
use Illuminate\Routing\Controller;
use PayHere\PayHere;
 
class Checkout extends Controller
{
    public function __invoke()
    {
        return PayHere::builder()
            ->guest()
            ->title("Bold 'LN' Logo Retro Trucker Hat")
            ->amount(25)
            ->checkout();
    }
}

When this route is visited, it will redirect the user to PayHere to complete the payment. Once completed, they will be redirected back to your site or to a return URL you define using the PAYHERE_RETURN_URL environment variable in your .env file.

Suppose you prefer to have an Onsite checkout experience for your users. In that case, Laravel PayHere allows you to load the PayHere JavaScript SDK to your Blade template using the @payhereJS Blade directive right before your application layout's closing </head> tag. There is also a Blade component available to add Payment Buttons. An example would be:

<x-payhere::button
    :order="PayHere\PayHere::builder()->guest()->amount(100)->getOrder()"
    class="px-8 py-4"
>
    Buy Now
</x-payhere::button>

Discover more about this package and its features in the official documentation, and take a look at the source code on GitHub.