PHPackages                             rapid/gateway-ir - 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. rapid/gateway-ir

ActiveLibrary

rapid/gateway-ir
================

Iranian Gateways

137PHP

Since Jan 10Pushed 7mo agoCompare

[ Source](https://github.com/rapidphp/gateway-ir)[ Packagist](https://packagist.org/packages/rapid/gateway-ir)[ RSS](/packages/rapid-gateway-ir/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (4)Used By (0)

Gateway IR
==========

[](#gateway-ir)

This package allows you to easily and powerfully use Iranian gateways in Laravel.

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

[](#installation)

```
composer require rapid/gateway-ir
```

*Optional to publish assets:*

```
php artisan vendor:publish --provider="Rapid\GatewayIR\GatewayIRServiceProvider"
```

Supported Portals
-----------------

[](#supported-portals)

PortalClassHas SandboxTestedDescriptionInternal Sandbox`InternalSandbox`---yesTesting portal in local hostZarin Pal`ZarinPal`yesnoNext Pay`NextPay`nonoID Pay`IDPay`yesnoPortals
-------

[](#portals)

### Fixed Portals

[](#fixed-portals)

This section defines the available payment gateway portals that can be used for processing payments. Each portal should be configured with the necessary settings and credentials.

```
use Rapid\GatewayIR\Portals;

'portals' => [

    'zarinpal' => [
        'driver' => Portals\ZarinPal::class,
        'key' => env('GATEWAY_ZARINPAL_KEY', '9f82b83f-7893-4b2e-93b8-9a096ceb3428'),
        'sandbox' => env('GATEWAY_ZARINPAL_SANDBOX', false),
    ],

    'idpay' => [
        'driver' => Portals\IDPay::class,
        'key' => env('GATEWAY_IDPAY_KEY', ''),
        'sandbox' => env('GATEWAY_IDPAY_SANDBOX', false),
    ],

    'nextpay' => [
        'driver' => Portals\NextPay::class,
        'key' => env('GATEWAY_NEXTPAY_KEY', ''),
    ],

    'internal_sandbox' => [
        'driver' => Portals\InternalSandbox::class,
    ],

],
```

You can now define default and secondary values using the portals you have created:

```
'default' => env('GATEWAY_DEFAULT', 'zarinpal'),

'secondary' => env('GATEWAY_SECONDARY', 'idpay'),
```

And you can use the `payment` helper to access the portal instance:

```
$default = payment();
$secondary = Payment::secondary();
$idpay = payment('idpay');
```

### Dynamic Portals

[](#dynamic-portals)

You can also define dynamic portals using the `define` method in service providers:

```
Payment::define('my_portal', function () {
    return new ZarinPal('key');
});
```

Payment
-------

[](#payment)

### New Transaction

[](#new-transaction)

```
return payment()
    ->request(2000, 'Description', MyHandler::class, ['meta' => null])
    ->redirect();
```

```
class MyHandler extends PaymentHandler
{
    public function setup(HandleSetup $setup): void
    {
        $setup
            ->success(function (PaymentVerifyResult $result) {
                return "Payment success!";
            });
    }
}
```

Or pass an instance of handler:

```
return payment()
    ->request(2000, 'Description', new MyHandler(), ['meta' => null])
    ->redirect();
```

### Payment Handler

[](#payment-handler)

Handlers remember their variables and respond to payments. Therefore, you can store payment information in these classes that you define yourself and then implement payment logic.

```
class BuyProductHandler extends PaymentHandler
{
    public function __construct(
        protected User $user,
        protected Product $product,
    ) {}

    public function setup(HandleSetup $setup): void
    {
        $setup
            ->validate(function (PaymentPrepare $prepare) {
                return !$this->user->boughts()->where('product_id', $this->product->id)->exists() &&
                    $this->product->price == $prepare->amount;
            })
            ->success(function (PaymentVerifyResult $result) {
                $this->user->boughts()->create(['product_id' => $this->product->id]);

                event(new ProductBought($this->user, $this->product));

                return view('payment.success', ['to' => route('product.show', $this->product)]);
            })
            ->cancel(function () {
                return view('payment.cancel');
            })
            ->fail(function () {
                return view('payment.fail');
            });
    }
}
```

Usage:

```
public function buy(Product $product)
{
    return payment()
        ->request($product->price, 'Buy ' . $product->name, new BuyProductHandler(auth()->user(), $product))
        ->redirect();
}
```

Exception Handling
------------------

[](#exception-handling)

Initially, you should prevent errors from occurring in your Handler! Because executing an error after payment verification can result in the loss of the customer's money.

However, if for any reason an error occurs, Gateway-IR tries to resolve the issue in two ways:

1. If the payment gateway supports refunds, it will execute it. If it fails for any reason, the second method will be executed next.
2. In the end, the program tries to re-execute the operation with the help of a queue. Your code will be re-executed in the queue approximately 10 times until no more errors occur! However, if the error persists, there is nothing more we can do. All errors are logged, and in the transactions table, the state of incomplete transactions is set to `pend_in_queue`.

> Important: Don't throw errors for reverting the transaction!

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance44

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity20

Early-stage or recently created project

 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.

### Community

Maintainers

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

---

Top Contributors

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

### Embed Badge

![Health badge](/badges/rapid-gateway-ir/health.svg)

```
[![Health](https://phpackages.com/badges/rapid-gateway-ir/health.svg)](https://phpackages.com/packages/rapid-gateway-ir)
```

PHPackages © 2026

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