PHPackages                             thejano/areeba-payment-laravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. thejano/areeba-payment-laravel

ActiveLibrary[Payment Processing](/categories/payments)

thejano/areeba-payment-laravel
==============================

A Laravel package for Areeba payment gateway integration.

1.1.0(8mo ago)3311MITPHPPHP >=8.2

Since Feb 10Pushed 8mo ago1 watchersCompare

[ Source](https://github.com/thejano/areeba-payment-laravel)[ Packagist](https://packagist.org/packages/thejano/areeba-payment-laravel)[ RSS](/packages/thejano-areeba-payment-laravel/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (3)Used By (0)

Areeba Payment Laravel Package
==============================

[](#areeba-payment-laravel-package)

[![Areeba Payment](https://camo.githubusercontent.com/776b1e7c95f973af57e962fd9649e7a0915925f88309f113717af822b303b342/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c61726176656c2d6172656562612d626c75652e737667)](https://camo.githubusercontent.com/776b1e7c95f973af57e962fd9649e7a0915925f88309f113717af822b303b342/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c61726176656c2d6172656562612d626c75652e737667)

A Laravel package for integrating with Areeba Payment Gateway.

Payment Flow
------------

[](#payment-flow)

This flow requires you to redirect the end-user to the payment page as advised in the `redirectUrl` response.

1. Initiate the payment with the appropriate API call.
2. Upon success, the Gateway responds with a result containing `returnType` as `REDIRECT` and the URL in `redirectUrl`.
3. You redirect the user to the given URL (usually via a `Location` header).
4. The user completes the payment process on the payment page.
5. The Gateway sends an asynchronous status notification to the URL provided in the initial API call.
6. The user will be redirected to the `successUrl`, `errorUrl`, or `cancelUrl` based on the transaction status. The URL will contain the `transactionId` as a query parameter: `url?transactionId={{$transactionId}}`.

Installation
------------

[](#installation)

You can install the package via Composer:

```
composer require thejano/areeba-payment-laravel
```

Configuration
-------------

[](#configuration)

Publish the configuration file:

```
php artisan vendor:publish --provider="TheJano\AreebaPayment\Providers\AreebaPaymentServiceProvider"
```

This will create a `config/areeba.php` file.

Set your environment variables in `.env`:

```
AREEBA_API_KEY=your_api_key
AREEBA_USERNAME=your_username
AREEBA_PASSWORD=your_password
AREEBA_BASE_URL=https://gateway.areebapayment.com/api/v3
AREEBA_LANGUAGE=en
AREEBA_TRANSACTION_PREFIX=MYAPP-
AREEBA_SUCCESS_REDIRECT_URL=https://yourapp.com/payment/success
AREEBA_ERROR_REDIRECT_URL=https://yourapp.com/payment/error
AREEBA_CANCEL_REDIRECT_URL=https://yourapp.com/payment/cancel
AREEBA_CALLBACK_REDIRECT_URL=https://yourapp.com/payment/callback
```

Usage
-----

[](#usage)

### Using the Service Class for Payment Initiation

[](#using-the-service-class-for-payment-initiation)

```
use TheJano\AreebaPayment\Services\AreebaPayment;

$paymentData = AreebaPayment::make()->initiatePayment('TXN123456', '100.00', 'John Doe');

$paymentUrl = $paymentData->redirectUrl;

return redirect($paymentUrl);
```

### Using the Facade

[](#using-the-facade)

```
use TheJano\AreebaPayment\Facades\AreebaPayment;

$paymentData = AreebaPayment::initiatePayment('TXN123456', '100.00', 'John Doe');

$paymentUrl = $paymentData->redirectUrl;

return redirect($paymentUrl);
```

Request Response Data Properties
--------------------------------

[](#request-response-data-properties)

The `AreebaPaymentRequestData` contains the following properties:

- `success` (bool) - Indicates if the request was successful.
- `uuid` (string|null) - Unique identifier for the transaction.
- `purchaseId` (string|null) - The purchase reference ID.
- `returnType` (string|null) - Type of return response (e.g., `REDIRECT`).
- `redirectUrl` (string|null) - URL where the user should be redirected to complete payment.
- `paymentMethod` (string|null) - Payment method used by the user.
- `errorMessage` (string|null) - Error message in case of failure.
- `errorCode` (int|null) - Error code if the transaction failed.

Based on the transaction status, the user will be redirected to the appropriate URL with `?transactionId={{$transactionId}}` appended.

---

Checking Payment Status
-----------------------

[](#checking-payment-status)

```
use TheJano\AreebaPayment\Facades\AreebaPayment;

$checkResponse = AreebaPayment::checkPaymentStatus('TXN123456');
```

This will return a JSON response including `transactionStatus` with possible values:

- `SUCCESS` - Transaction was successful.
- `REDIRECT` - Transaction has not been processed yet.
- `ERROR` - Transaction failed.

License
-------

[](#license)

This package is open-source and licensed under the [MIT License](LICENSE).

API Documentation
-----------------

[](#api-documentation)

For more details, visit the official API documentation:

[https://www.areeba.com/projects/areeba\_gateway/integration](https://www.areeba.com/projects/areeba_gateway/integration)

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance61

Regular maintenance activity

Popularity14

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~209 days

Total

2

Last Release

247d ago

PHP version history (2 changes)1.0.0PHP >=8.1

1.1.0PHP >=8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/c3bae4eda28dfbd2e4a288a22c49c4a93c504c7b483e8d8353d7fea1eabcd921?d=identicon)[drpshtiwan](/maintainers/drpshtiwan)

---

Top Contributors

[![drpshtiwan](https://avatars.githubusercontent.com/u/6718949?v=4)](https://github.com/drpshtiwan "drpshtiwan (4 commits)")

### Embed Badge

![Health badge](/badges/thejano-areeba-payment-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/thejano-areeba-payment-laravel/health.svg)](https://phpackages.com/packages/thejano-areeba-payment-laravel)
```

###  Alternatives

[laraveldaily/laravel-invoices

Missing invoices for Laravel

1.5k1.3M4](/packages/laraveldaily-laravel-invoices)[musahmusah/laravel-multipayment-gateways

A Laravel Package that makes implementation of multiple payment Gateways endpoints and webhooks seamless

852.2k1](/packages/musahmusah-laravel-multipayment-gateways)[karson/mpesa-php-sdk

172.2k](/packages/karson-mpesa-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)