PHPackages                             behzadbabaei/omnipay-thawani - 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. behzadbabaei/omnipay-thawani

ActiveLibrary

behzadbabaei/omnipay-thawani
============================

Thawani (Oman Payment) driver for the Omnipay payment processing library

v1.1.0(4y ago)3816↓50%MITPHPPHP ^7.2|^8

Since Nov 22Pushed 4y ago1 watchersCompare

[ Source](https://github.com/behzadbabaei/omnipay-thawani)[ Packagist](https://packagist.org/packages/behzadbabaei/omnipay-thawani)[ Docs](https://github.com/behzadbabaei/omnipay-thawani)[ RSS](/packages/behzadbabaei-omnipay-thawani/feed)WikiDiscussions master Synced 1mo ago

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

Omnipay Thawani
===============

[](#omnipay-thawani)

Thawani gateway for Omnipay payment processing library This package has implemtend the Checkout API of Thawani Payment systems For more information please visit the following link:[Developer Document](https://docs.thawani.om/docs/thawani-ecommerce-api/YXBpOjExMDU2Mzgy-thawani-e-commerce-api)

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

[](#installation)

Omnipay is installed via [Composer](http://getcomposer.org/). To install, simply add it to your `composer.json` file:

```
{
    "require": {
        "behzadbabaei/omnipay-thawani": "dev-master"
    }
}
```

And run composer to update your dependencies:

```
composer update

```

Or you can simply run

```
composer require behzadbabaei/omnipay-thawani

```

Basic Usage
-----------

[](#basic-usage)

1. Use Omnipay gateway class:

```
    use Omnipay\Omnipay;
```

2. Initialize Thawani gateway:

```
            $gateway = Omnipay::create('Thawani');
            $gateway->setPublishKey('publish-key');
            $gateway->setSecretKey('secret-key');
            $gateway->setTestMode(true-false);
```

Creating an session
===================

[](#creating-an-session)

Call purchase, it will return the response which includes the session\_id for further process. Please refer to the [Developer Document](https://docs.thawani.om/docs/thawani-ecommerce-api/b3A6MTEwNTYzODQ-create-session) for more information.

```
            $purchase = $gateway->purchase();
            $purchase->setAmount(12000);
            $purchase->setQuantity(1);
            $purchase->setProductName("product name test1"); //Product name is required
            $purchase->setTransactionId($data['transactionId']); //TransactionId is required
            $purchase->setCustomerId('');
            $purchase->setReturnUrl('https://www.example.com/thawani/success'); //The success url is required
            $purchase->setCancelUrl('https://www.example.com/thawani/cancel');  //The cancel url is required
            $purchase->setSaveCardOnSuccess(false);
            $purchase->setPlanId('');
            // The metadata about the customer is required, like name, email
            $purchase->setMetadata([
                'orderId' => $data['transactionId'],
                'customerId' => $data['customerId'] ?? null,
                'customerEmail' => $data['customerEmail'] ?? null,
                'customerName' => $data['customerName'] ?? null,// user full name
            ]);

            $result = $purchase->send();
            $response = $result->getData();
            $redirectUrl = $result->getRedirectUrl();
```

OR

```
            $result = $gateway->purchase([
                'amount' => 12000,
                'quantity' => 1,
                'productName' => 'product name test2',
                'transactionId' => $data['transactionId'],
                'customerId' => '',
                'returnUrl' => 'https://www.example.com/thawani/success',
                'cancelUrl' => 'https://www.example.com/thawani/cancel',
                'saveCardOnSuccess' => false,
                'planId' => '',
                'metadata' => [
                    'orderId' => $data['transactionId'],
                    'customerId' => $data['customerId'] ?? null,
                    'customerEmail' => $data['customerEmail'] ?? null,
                    'customerName' => $data['customerName'] ?? null,// user full name
                ]
            ])->send();

            $response = $result->getData();
            $redirectUrl = $result->getRedirectUrl();
```

Retrieve an order
=================

[](#retrieve-an-order)

Please refer to the [Developer Document](https://docs.thawani.om/docs/thawani-ecommerce-api/b3A6MTEwNTYzODU-retrieve-session) for more information.

```
            $fetch = $gateway->fetchTransaction();
            $fetch->setOrderId($orderId);
            $result = $fetch->send()->getData();
```

OR

```
            $fetch = $gateway->fetchTransaction(
                [
                    'orderId' => $orderId
                ]
            );
            $result = $fetch->send()->getData();
```

For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay)repository.

Support
-------

[](#support)

If you are having general issues with Omnipay, we suggest posting on [Stack Overflow](http://stackoverflow.com/). Be sure to add the [omnipay tag](http://stackoverflow.com/questions/tagged/omnipay) so it can be easily found.

If you want to keep up to date with release announcements, discuss ideas for the project, or ask more detailed questions, there is also a [mailing list](https://groups.google.com/forum/#!forum/omnipay) which you can subscribe to.

If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/behzadbabaei/omnipay-thawani/issues), or better yet, fork the library and submit a pull request.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity46

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 ~0 days

Total

2

Last Release

1633d ago

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

omnipaythawani

### Embed Badge

![Health badge](/badges/behzadbabaei-omnipay-thawani/health.svg)

```
[![Health](https://phpackages.com/badges/behzadbabaei-omnipay-thawani/health.svg)](https://phpackages.com/packages/behzadbabaei-omnipay-thawani)
```

###  Alternatives

[league/omnipay

Omnipay payment processing library

6.1k9.7M166](/packages/league-omnipay)[silverstripe/silverstripe-omnipay

SilverStripe Omnipay Payment Module

38106.0k15](/packages/silverstripe-silverstripe-omnipay)

PHPackages © 2026

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