PHPackages                             jkbroot/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. [Payment Processing](/categories/payments)
4. /
5. jkbroot/thawani

ActiveLibrary[Payment Processing](/categories/payments)

jkbroot/thawani
===============

A Laravel package for Thawani payment gateway integration.

1.1.1(2y ago)32.0k↑804.8%MITPHPPHP ^7.3|^8.0

Since Feb 28Pushed 2y ago1 watchersCompare

[ Source](https://github.com/jkbroot/thawani)[ Packagist](https://packagist.org/packages/jkbroot/thawani)[ RSS](/packages/jkbroot-thawani/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (0)

[![alt tag](https://camo.githubusercontent.com/8c9aaa7c1e8fcc0bc2812291cdbac9fb5b85cea18f25f0d86fb13ec66e6b035f/68747470733a2f2f74686177616e692e6f6d2f77702d636f6e74656e742f75706c6f6164732f323032322f31322f4c6f676f2d54686177616e692e706e67)](https://camo.githubusercontent.com/8c9aaa7c1e8fcc0bc2812291cdbac9fb5b85cea18f25f0d86fb13ec66e6b035f/68747470733a2f2f74686177616e692e6f6d2f77702d636f6e74656e742f75706c6f6164732f323032322f31322f4c6f676f2d54686177616e692e706e67)

jkbroot/thawani
===============

[](#jkbrootthawani)

This Laravel package facilitates easy integration with the Thawani payment gateway, offering a straightforward and intuitive set of functionalities for payment session creation, customer management, and transaction handling, all within your Laravel application.

Features
========

[](#features)

- Easy integration with Laravel applications
- Support for creating and managing Thawani checkout sessions
- Customer management utilities
- Payment and refund handling
- Support for payment intents

**Requirements**

- PHP 7.3 or higher
- Laravel 6.0 or higher

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

[](#installation)

```
composer require jkbroot/thawani
```

This package supports Package Auto-Discovery, which was introduced in Laravel 5.5. Therefore, it doesn't require manual registration of the ServiceProvider in most cases.

If you're using a version of Laravel where auto-discovery is not supported or have specifically disabled it, you need to register the ServiceProvider manually.

Add the ServiceProvider to the providers array in config/app.php:

```
'providers' => [
    // Other Service Providers

    Jkbroot\Thawani\ThawaniServiceProvider::class,
],
```

**Configuration:**

Publish the configuration file by running the following Artisan command. This will publish the Thawani configuration file to config/thawani.php, where you can customize your settings.

```
php artisan vendor:publish --tag=config
```

*Copy the Thawani Pay configuration snippet you provided and paste it into your .env file. However,The THAWANI\_MODE should be set to live instead of test for a production environment :*

```
#Thawani Pay Configuration for Production Environment
THAWANI_LIVE_SECRET_KEY=your_thawani_live_secret_key
THAWANI_LIVE_PUBLISHABLE_KEY=your_thawani_live_publishable_key
#Thawani mode change to (live) for production.
THAWANI_MODE=test

```

Replace your\_thawani\_live\_secret\_key and your\_thawani\_live\_publishable\_key with your actual Thawani live secret and publishable keys.

Instantiating ThawaniPay Class
------------------------------

[](#instantiating-thawanipay-class)

To begin using the Thawani payment functionality, you need to instantiate the `ThawaniPay` class. Follow these steps:

### Step 1: Import ThawaniPay Class

[](#step-1-import-thawanipay-class)

Before you can create an instance of the `ThawaniPay` class, ensure that you import it into your PHP file using the `use` statement:

```
use Jkbroot\Thawani\ThawaniPay;
```

### Step 2: Instantiate ThawaniPay Class

[](#step-2-instantiate-thawanipay-class)

Once the class is imported, you can instantiate it using the following code:

```
$thawani = new ThawaniPay();
```

This creates an instance of the ThawaniPay class, allowing you to utilize its methods and properties for handling Thawani payments within your Laravel application.

**Additional Notes**

- Ensure that you have installed the jkbroot/thawani package via Composer before attempting to use it.
- Review the package documentation for any specific configurations, requirements, or additional functionality provided by the package.

How to use :
============

[](#how-to-use-)

1 - checkout & session
--------------------------

[](#1---checkout--session)

- Create session :

```
use Jkbroot\Thawani\ThawaniPay;

$thawani = new ThawaniPay();

$data = [
    "client_reference_id" => "123412",
    "mode" => "payment",
    "products" => [
        [
            "name" => "product 1",
            "quantity" => 1,
            "unit_amount" => 100,
        ],
    ],
    "success_url" => "https://company.com/success",
    "cancel_url" => "https://company.com/cancel",
    "metadata" => [
        "Customer name" => "somename",
        "order id" => 0,
    ],
];

$session = $thawani->checkoutSessions->create($data);
```

Create session Response :

```
[
    "success" => true
    "code" => 2004
    "description" => "Session generated successfully"
    "data" => array:16 [
        "mode" => "payment"
        "session_id" => "checkout_0Cp4idrQaNFMws8YFJH020FJA3I4ITwkvmk2RxUc9Les5kY3ym"
        "client_reference_id" => "123412"
        "customer_id" => null
        "products" => [
          0 => [
            "name" => "product 1"
            "unit_amount" => 100
            "quantity" => 1
          ]
        ]
        "total_amount" => 100
        "currency" => "OMR"
        "success_url" => "https://company.com/success"
        "cancel_url" => "https://company.com/cancel"
        "return_url" => null
        "payment_status" => "unpaid"
        "invoice" => "20240228270008"
        "save_card_on_success" => false
        "metadata" => [
          "Customer name" => "somename"
          "order id" => "0"
        ]
        "created_at" => "2024-02-28T15:19:35.2937785Z"
        "expire_at" => "2024-02-29T15:19:35.2204113Z"
    ]
]
```

- Retrieve session :

```
$session_id = "checkout_0Cp4idrQaNFMws8YFJH020FJA3I4ITwkvmk2RxUc9Les5kY3ym";
$session = $thawani->checkoutSessions->retrieve($session_id);
```

Retrieve session Response :

```
[
  "success" => true
  "code" => 2000
  "description" => "session retrieved successfully"
  "data" =>  [
    "mode" => "payment"
    "session_id" => "checkout_0Cp4idrQaNFMws8YFJH020FJA3I4ITwkvmk2RxUc9Les5kY3ym"
    "client_reference_id" => "123412"
    "customer_id" => null
    "products" => [
      0 => [
        "name" => "product 1"
        "unit_amount" => 100
        "quantity" => 1
      ]
    ]
    "total_amount" => 100
    "currency" => "OMR"
    "success_url" => "https://company.com/success"
    "cancel_url" => "https://company.com/cancel"
    "return_url" => null
    "payment_status" => "unpaid"
    "invoice" => "20240228270008"
    "save_card_on_success" => false
    "metadata" =>[
      "Customer name" => "somename"
      "order id" => "0"
    ]
    "created_at" => "2024-02-28T15:19:35.2937785"
    "expire_at" => "2024-02-29T15:19:35.2204113"
  ]
]
```

- Cancel session :

```
$session_id = "checkout_0Cp4idrQaNFMws8YFJH020FJA3I4ITwkvmk2RxUc9Les5kY3ym";
$session = $thawani->checkoutSessions->cancel($session_id);
```

Cancel session Response :

```
[
  "success" => true
  "code" => 2105
  "description" => "Checkout session cancelled successfully"
]
```

- list Sessions :

```
$sessions = $thawani->checkoutSessions->list();

//for limit the lists and paginate between lists (limit,skip)
$sessions = $thawani->checkoutSessions->list(10,0);
```

list Sessions Response :

```
[
  "success" => true
  "code" => 2000
  "description" => "sessions retrieved successfully"
  "data" => [/*'array off Sessions'*/]
]
```

- create Checkout Url :

```
$data = [
    "client_reference_id" => "123412",
    "mode" => "payment",
    "products" => [
        [
            "name" => "product 1",
            "quantity" => 1,
            "unit_amount" => 100,
        ],
    ],
    "success_url" => "https://company.com/success",
    "cancel_url" => "https://company.com/cancel",
    "metadata" => [
        "Customer name" => "somename",
        "order id" => 0,
    ],
];

$checkoutUrl = $thawani->checkoutSessions->createCheckoutUrl($data);
```

- create Checkout Url Response:

```
[
  "session_id" => "checkout_5Q3IPYhiWaOIDotTqHJMjtaklHoHeWTjT6iTPaT0kQSTSZF3Za"
  "redirect_url" => "https://uatcheckout.thawani.om/pay/checkout_5Q3IPYhiWaOIDotTqHJMjtaklHoHeWTjT6iTPaT0kQSTSZF3Za?key=HGvTMLDssJghr9tlN9gr4DVYt0qyBy"
]
```

- session\_id: A unique identifier for the created checkout session.
- redirect\_url: The URL to which you should redirect your customers to complete the payment process. This URL leads to Thawani's payment gateway, where the customer can enter their payment details securely.

2 - Customers
-------------

[](#2---customers)

- create customer :

```
$data = [
        "client_customer_id" => "customer@example.com"
    ];

$customer = $thawani->customers->create($data);
```

- create customer Response:

```
[
  "success" => true
  "code" => 2001
  "description" => "Customer added successfully"
  "data" =>[
    "id" => "cus_pbW3HE7eG81zRvJX"
    "customer_client_id" => "customer@example.com"
  ]
]
```

- retrieve customer :

```
$customerId = 'cus_pbW3HE7eG81zRvJX';
$customer = $thawani->customers->retrieve($customerId);
```

- retrieve customer Response:

```
[
  "success" => true
  "code" => 2000
  "description" => "Customers retrieved successfully"
  "data" => [
    "id" => "cus_pbW3HE7eG81zRvJX"
    "customer_client_id" => "customer@example.com"
  ]
]
```

- delete customer :

```
$customerId = 'cus_pbW3HE7eG81zRvJX';
$customer = $thawani->customers->delete($customerId);
```

- list customers :

```
$customers = $thawani->customers->list();

//for limit the lists and paginate between lists (limit,skip)
$customers = $thawani->customers->list(10,0);
```

3 - Pyament Intents
-------------------

[](#3---pyament-intents)

- list payment intent :

```
$paymentIntents = $thawani->paymentIntents->list();

//for limit the lists and paginate between lists (limit,skip)

$paymentIntents = $thawani->paymentIntents->list(10,0);
```

- list payment intent Response:

```
[
  "success" => true
  "code" => 2000
  "description" => "sessions retrieved successfully"
  "data" => [/*'array off Payment intents'*/]
]
```

- create payment intent :

```
$data = [
    "amount" => 100,
    "payment_method" => "card_zK5a7sd98wdwe78TbiSUyLUjann6xFx",
    "description" => "Payment for order 123412",
    "client_reference_id" => "123412",
    "return_url" => "https://thw.om/success",
    "metadata" => [
        "Customer name" => "somename",
    ],
];

$paymentIntent = $thawani->paymentIntents->create($data);
```

- create payment intent Response:

```
{
  "success": true,
  "code": 0,
  "description": "string",
  "data": {
    "id": "string",
    "client_reference_id": "string",
    "amount": 0,
    "currency": "string",
    "payment_method": "string",
    "next_action": {
      "url": "string",
      "return_url": "string"
    },
    "status": "requires_payment_method",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "expire_at": "2019-08-24T14:15:22Z"
  }
}
```

Here's a concise explanation for each method in the supported classes of your Laravel package for integrating the Thawani payment gateway:
==========================================================================================================================================

[](#heres-a-concise-explanation-for-each-method-in-the-supported-classes-of-your-laravel-package-for-integrating-the-thawani-payment-gateway)

### CheckoutSessions

[](#checkoutsessions)

- `create`: Initializes a new payment session.
- `retrieve`: Fetches details of a specific session.
- `cancel`: Cancels an existing session.
- `list`: Lists all sessions with optional pagination.
- `createCheckoutUrl`: Generates a URL for the payment checkout page.
- `retrieveByClientReference`: Retrieves a session using a client-provided reference ID.
- `retrieveByInvoice`: Retrieves a session using an invoice number.

### Customers

[](#customers)

- `create`: Registers a new customer in the payment system.
- `retrieve`: Retrieves information about a specific customer.
- `delete`: Removes a customer from the system.
- `list`: Lists all customers with optional pagination.

### PaymentIntents

[](#paymentintents)

- `create`: Creates a payment intent to initiate a transaction.
- `retrieve`: Fetches details of a specific payment intent.
- `cancel`: Cancels an unresolved payment intent.
- `list`: Lists payment intents with optional pagination.
- `confirm`: Confirms a payment intent, attempting to finalize the transaction.

### PaymentMethods

[](#paymentmethods)

- `list`: Lists all payment methods associated with a given customer ID.
- `delete`: Deletes a specified payment method from a customer's account.

### Refunds

[](#refunds)

- `create`: Initiates a refund for a specific transaction.
- `retrieve`: Retrieves details of a specific refund.
- `list`: Lists all refunds with optional pagination.

This overview provides a quick guide to the functionalities available in your Laravel package for integrating Thawani payment services.

###  Health Score

28

—

LowBetter than 52% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity50

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

Total

5

Last Release

823d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d953147e6b1f5c820428c19c01d04692764f9887f07a4d4faf0cddf514164a71?d=identicon)[0jkb](/maintainers/0jkb)

---

Top Contributors

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

---

Tags

laravelpayment processinggatewayecommercepayment gatewaypayment-integrationonline paymentsthawanithawaniPaymentthawani api

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[cybersource/rest-client-php

Client SDK for CyberSource REST APIs

40952.8k6](/packages/cybersource-rest-client-php)

PHPackages © 2026

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