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.

2.0.0(1mo ago)4392MITPHPPHP >=8.2CI passing

Since Feb 10Pushed 1mo 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 1w ago

READMEChangelog (3)Dependencies (5)Versions (4)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.

The package supports two Areeba products:

- **IXOPAY** (default) — the transaction-based gateway hosted at `gateway.areebapayment.com`.
- **MPGS / ePayment** — Areeba's hosted-checkout product on `epayment.areeba.com`, backed by MasterCard Payment Gateway Services. See [Using the MPGS / ePayment Driver](#using-the-mpgs--epayment-driver) below.

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.

Using the MPGS / ePayment Driver
--------------------------------

[](#using-the-mpgs--epayment-driver)

Areeba also offers a hosted-checkout product (MPGS / ePayment) on `https://epayment.areeba.com`. It uses a different API than the IXOPAY gateway above: you create a checkout `session`, redirect the user to a hosted page (or embed `checkout.js`), and later query the `order` resource for the final payment status.

### Selecting the Driver

[](#selecting-the-driver)

Set `AREEBA_DRIVER=mpgs` in your `.env` to make `app(PaymentGateway::class)` resolve to the MPGS driver. Leaving it unset keeps the default IXOPAY behavior unchanged.

```
AREEBA_DRIVER=mpgs
```

Alternatively, you can call the MPGS service directly without changing the default driver — the IXOPAY service remains available either way.

### MPGS Environment Variables

[](#mpgs-environment-variables)

The MPGS credentials are namespaced under `AREEBA_MPGS_*` so they do not collide with the IXOPAY keys:

```
AREEBA_MPGS_BASE_URL=https://epayment.areeba.com
AREEBA_MPGS_API_VERSION=100
AREEBA_MPGS_MERCHANT_ID=your_merchant_id
AREEBA_MPGS_USERNAME=merchant.your_merchant_id
AREEBA_MPGS_PASSWORD=your_password
AREEBA_MPGS_CURRENCY=USD
AREEBA_MPGS_CHECKOUT_VERSION=1.0.0
AREEBA_MPGS_RETURN_REDIRECT_URL=https://yourapp.com/payment/return
AREEBA_MPGS_CANCEL_REDIRECT_URL=https://yourapp.com/payment/cancel
AREEBA_MPGS_TIMEOUT_REDIRECT_URL=https://yourapp.com/payment/timeout
```

The three redirect URLs are sent to MPGS as the `interaction.returnUrl`, `interaction.cancelUrl`, and `interaction.timeoutUrl` fields when a checkout session is created. MPGS will land the user on `returnUrl` whether the payment succeeded or failed — inspect the resulting `order.status` (see [Checking Payment Status](#checking-payment-status-1)) to decide how to render the page.

### Usage

[](#usage-1)

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

$paymentData = AreebaMpgsPayment::make()->initiatePayment('ORDER-123', '100.00', 'John Doe');

// $paymentData->purchaseId  → MPGS session id (use it with checkout.js)
// $paymentData->redirectUrl → hosted-checkout URL (use it for a plain redirect flow)
return redirect($paymentData->redirectUrl);
```

Or via the facade:

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

$paymentData = AreebaMpgsPayment::initiatePayment('ORDER-123', '100.00', 'John Doe');
```

### Getting Just the Session ID or Payment Link

[](#getting-just-the-session-id-or-payment-link)

If you don't need the full `AreebaPaymentRequestData` object, two convenience methods return the value you want as a plain string (or `null` if the gateway call fails — the failure is already logged via Laravel's logger):

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

// Hosted-checkout redirect URL
$paymentLink = AreebaMpgsPayment::getPaymentLink('ORDER-123', '100.00', 'John Doe');
if ($paymentLink === null) {
    abort(502, 'Payment gateway unavailable');
}
return redirect($paymentLink);

// MPGS session ID (for embedded checkout.js)
$sessionId = AreebaMpgsPayment::getSessionId('ORDER-123', '100.00', 'John Doe');
return view('checkout', ['sessionId' => $sessionId]);
```

Both methods accept the same arguments as `initiatePayment()` and call it internally — they are pure projections of its result, so there is no extra network round-trip. Use `initiatePayment()` directly when you also need the error message or other fields on failure.

### Embedded Checkout vs. Redirect

[](#embedded-checkout-vs-redirect)

The `purchaseId` returned from `initiatePayment` is the MPGS `session.id`. With it you can either:

1. **Redirect** the user to `$paymentData->redirectUrl` (the hosted checkout page), or
2. **Embed** `checkout.js` on your own page and call:

    ```

      Checkout.configure({ session: { id: '' } });
      Checkout.showPaymentPage();

    ```

### Checking Payment Status

[](#checking-payment-status-1)

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

$response = AreebaMpgsPayment::checkPaymentStatus('ORDER-123');
// Inspect $response['status'] — values include CAPTURED, AUTHORIZED, FAILED, DECLINED, EXPIRED, CANCELLED.
```

`checkPaymentStatus` returns the raw decoded JSON from MPGS so your application can map gateway-specific statuses to its own payment states.

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)

[https://www.areeba.com/documentations/areeba\_docs.integration.html](https://www.areeba.com/documentations/areeba_docs.integration.html)

###  Health Score

44

—

FairBetter than 90% of packages

Maintenance90

Actively maintained with recent releases

Popularity14

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 60% 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 ~252 days

Total

3

Last Release

49d ago

Major Versions

1.1.0 → 2.0.02026-06-30

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 (9 commits)")[![AlaaOkasha360](https://avatars.githubusercontent.com/u/88963518?v=4)](https://github.com/AlaaOkasha360 "AlaaOkasha360 (6 commits)")

###  Code Quality

TestsPest

### 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

[linkxtr/laravel-qrcode

A clean, modern, and easy-to-use QR code generator for Laravel

3827.1k](/packages/linkxtr-laravel-qrcode)

PHPackages © 2026

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