PHPackages                             aminkt/yii2-payment-module - 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. aminkt/yii2-payment-module

ActiveYii2-extension[Payment Processing](/categories/payments)

aminkt/yii2-payment-module
==========================

Online payment module for yii2

v2.0.0(6y ago)11142PHPPHP >=7.1

Since Aug 21Pushed 1y ago1 watchersCompare

[ Source](https://github.com/aminkt/yii2-payment-module)[ Packagist](https://packagist.org/packages/aminkt/yii2-payment-module)[ RSS](/packages/aminkt-yii2-payment-module/feed)WikiDiscussions master Synced today

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

Contribute on this project
==========================

[](#contribute-on-this-project)

If you want i will happy to use your help to improve this project. For contributing please refer to this link.

[Contributing guide lines](contributing.md)

How to install this module:
===========================

[](#how-to-install-this-module)

Step1: Add flowing line to require part of `composer.json` :

```
"aminkt/yii2-payment-module": "*",

```

Or run bellow command :

```
composer require aminkt/yii2-payment-module

```

Step2: Add flowing lines in your application config:

```
'payment' => [
    'class' => aminkt\yii2\payment\Payment::class,
    'minAmount' => 100, // Min availbale money that can pay by gates.
    // If you want, same as minAmount you can set maxAmount.
    'maxAmount' => 1000000,
    // In Development you can uncomment below line to enable by pass mode.This config will pass the gates.
    // 'enableByPass' => true,
    'orderClass' => \common\models\Order::class,    Your order model class name.
    // Add this part to add your own gates.
    'components' => [
        'payment' => [
            'class' => aminkt\yii2\payment\components\Payment::class,
            // Uncomment below line if you wnat change you default callback address.
            // 'callback' => ['/v1/payment/verify'],
            'bankTimeout' => 60 * 30, // Max time user can be in bank site.
            'encryptKey' => 'wumBOOH04e', // This key will used to generate security token
            'blockTime' => 10, // How many times system allow to a user have risky actions.
            'gates' => [
               'Parsian' => [
                   'class' => \aminkt\yii2\payment\gates\Parsian::class,
                   'identityData' => [
                       'pin' => 'x8Xd1tR4So8kL50d3EV1',
                       'terminal' => '92133477'
                   ]
               ],
               'BehPardakht' => [
                   'class' => \aminkt\yii2\payment\gates\MellatGate::class,
                   'identityData' => [
                       'terminalId' => '****',
                       'userName' => '****',
                       'password' => '****',
                       'payerId' => 0,
                       'webService' => 'https://bpm.shaparak.ir/pgwchannel/services/pgw?wsdl',
                       'bankGatewayAddress' => 'https://bpm.shaparak.ir/pgwchannel/startpay.mellat',
                   ]
               ],

           ]
        ]
    ]
]
```

> All time please add Mellat Bank gate in down of gates list because it may make issue in automatic gate selector. Mellat gate throw an exception when it's not available that system can not catch it so the processes may become failed. If you can fix this please contribute.

Step3: Create your own order model and implement `aminkt\yii2\payment\interfaces\OrderInterface` in your order model. Using order model in this module is required.

> Note: Using a table as order model is an standard pattern to keep track of every thing you try to sale. refer this link to read more: [http://www.databaseanswers.org/data\_models/customers\_and\_orders/index.htm](http://www.databaseanswers.org/data_models/customers_and_orders/index.htm)

---

**Database Migrations**

Before usage this extension, we'll also need to prepare the database.

```
php yii migrate --migrationPath=@vendor/aminkt/yii2-payment-module/migrations

```

Usage:
======

[](#usage)

In your code when you want create a payment request use below code:

```
$payment = \aminkt\payment\Payment::getInstance()->payment;
$data = $payment->payRequest($orderModel);
```

> Use `$orderModel` to make a connection between your order table and payment data. by defining this you can access to your orders later from payment logs.

When users paid money, they will redirect in a page in you site that you defined. By default user will redirect to `/payment/default/verify` route.

For changing default call back page use below code:

```
$payment = \aminkt\payment\Payment::getInstance()->payment;
$payment->callback = ['/your-controller/your-action']; // callBack give an array defined a route.
```

> Also you can set callback address globally in module configuration.

In your verify page use below code to verify payment:

```
$verify = Payment::getInstance()
            ->getPayment()
            ->verify();

if($verify) {
    // Payment was successfull.
} else {
    // Paymen verify become failed.
}
```

`$verify` is `false` if verify action become failed and otherwise return an true.

Security
========

[](#security)

Module will check security issues and log them in yii2 log system. You can also define below attribute in payment component config to change default behavior of security system.

AttributeDefault valueDescriptionencryptKeyNullEncrypt key should be safe and long to encrypt payment token and is required.bankTimeoutNullTime that system can validate bank response. Default is null. Set time in second that if user returned from bank then system accept the response. If user do not return from bank in defined time then response will not accept.blockTime86400This value define if a user blocked how much should prevent action from that. If set null for ever considered. Value should be in secondallowedCredentialErrors5Max allowed times that a user can has credential errorsGate configuration
==================

[](#gate-configuration)

Every gate has some configuration. In this module prepared some default gates that you can use.

If you want create your own gate please refer to [Create gate class](#create-gate-class) section.

You can contribute your gates to this report and help me to improve productivity.

List of gates:

NameBankContributorConfiguration array`\aminkt\yii2\gates\Sep`[Saman](https://www.sb24.com)Amin Keshavarz [ak\_1596@yahoo.com](mailto:ak_1596@yahoo.com)[Sep gate configuration](#sep)`\aminkt\yii2\gates\MellatGate`[Mellat](http://behpardakht.com)Amin Keshavarz [ak\_1596@yahoo.com](mailto:ak_1596@yahoo.com)[Mellat gate configuration](#mellatgate)`\aminkt\yii2\gates\Parsian`[Parsian](https://www.parsian-bank.ir)Amin Keshavarz [ak\_1596@yahoo.com](mailto:ak_1596@yahoo.com)[Parsian gate configuration](#parsian)`\aminkt\yii2\gates\IranKish`[IranKish](http://www.kiccc.com)Amin Keshavarz [ak\_1596@yahoo.com](mailto:ak_1596@yahoo.com)[IraniKish gate configuration](#irankish)`\aminkt\yii2\gates\ZarinPal`[Zarinpal](http://zarinpal.com)Amin Keshavarz [ak\_1596@yahoo.com](mailto:ak_1596@yahoo.com)[ZarinPal gate configuration](#zarinpal)Create gate class
=================

[](#create-gate-class)

To create gate class you should create a new class in your application and extend it from `\aminkt\yii2\payment\gates\AbstractGate`.

Implement uncompleted methods and then use below rule to read identity data and configurations from module configuration:

As you know every gate has some configuration that user will prepare that as array. you can access this config from your gate by calling `getIdentity` methods.

For example if user use below configuration:

```
[
    'class' => \name\space\of\your\CustomGate::class,
    'password' => 'some password',
    'verifyUrl' => 'http://your/verify.url'
]
```

Then in `CustomGate` you can access below methods:

```
getIdentityPassword();
getIdentityVerifyUrl();
```

Implement your gate. see examples and if you like contribute it in this repo.

Gate configurations
-------------------

[](#gate-configurations)

Sep
---

[](#sep)

```
"Sep" => [
    'class' => \aminkt\payment\lib\Sep::className(),
    'identityData' => [
        'MID' => '******',
        'password' => '******',
        'bankGatewayAddress' => 'https://sep.shaparak.ir/payment.aspx',
        'webService' => "https://sep.shaparak.ir/payments/referencepayment.asmx?WSDL",
    ]
],
```

MellatGate
----------

[](#mellatgate)

```
'BehPardakht' => [
    'class' => \aminkt\yii2\payment\gates\MellatGate::class,
    'identityData' => [
        'terminalId' => '****',
        'userName' => '****',
        'password' => '****',
        'payerId' => 0,
        'webService' => 'https://bpm.shaparak.ir/pgwchannel/services/pgw?wsdl',
        'bankGatewayAddress' => 'https://bpm.shaparak.ir/pgwchannel/startpay.mellat',
    ]
],
```

Parsian
-------

[](#parsian)

```
'Parsian' => [
    'class' => \aminkt\yii2\payment\gates\Parsian::class,
    'identityData' => [
        'payRequestUrl' => 'https://pec.shaparak.ir/NewIPGServices/Sale/SaleService.asmx?WSDL',
        'verifyUrl' => 'https://pec.shaparak.ir/NewIPGServices/Confirm/ConfirmService.asmx?WSDL',
        'gateAddress' => 'https://pec.shaparak.ir/NewIPG/',
        'pin' => '**********',
        'terminal' => '********'
    ]
]
```

IranKish
--------

[](#irankish)

```
'IranKish' => [
    'class' => \aminkt\yii2\payment\gates\IranKish::class,
    'payRequestUrl' => 'https://ikc.shaparak.ir/XToken/Tokens.xml',
    'verifyUrl' => 'https://ikc.shaparak.ir/XVerify/Verify.xml',
    'gateAddress' => 'https://ikc.shaparak.ir/TPayment/Payment/index',
    'merchantId' => '******'
]
```

ZarinPal
--------

[](#zarinpal)

```
"Zarinpal" => [
    'class' => \aminkt\payment\lib\ZarinPal::className(),
    'identityData' => [
        'merchantCode' => '******',
        'redirectUrl' => 'https://zarinpal.com/pg/StartPay/%u',
        'payRequestUrl' => 'https://www.zarinpal.com/pg/rest/WebGate/PaymentRequest.json',
        'verifyRequestUrl' => 'https://www.zarinpal.com/pg/rest/WebGate/PaymentVerification.json',
        'isZarin' => false,
        'enableSandbox' => false
    ]
],
```

Reports:
========

[](#reports)

In older versions you can use some routes to see some views in your backend panel for logs but in this current we improve our module to use in rest modules so you still have a route to read logs but as `RESTAPI`.

This part documents not complete yet.

Structure of tables and classes:
================================

[](#structure-of-tables-and-classes)

[![Data base scheme](doc/structure.png)](doc/structure.png)

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity62

Established project with proven stability

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

Total

5

Last Release

2280d ago

Major Versions

1.0.2 → v2.0.02019-12-18

### Community

Maintainers

![](https://www.gravatar.com/avatar/8bbb96d5331db7b7c0f1003fdd294ad8865fe7df33cc68bf6cf6fad5550f461e?d=identicon)[aminkt](/maintainers/aminkt)

---

Tags

paymentgatewayyiishoppingonline

### Embed Badge

![Health badge](/badges/aminkt-yii2-payment-module/health.svg)

```
[![Health](https://phpackages.com/badges/aminkt-yii2-payment-module/health.svg)](https://phpackages.com/packages/aminkt-yii2-payment-module)
```

###  Alternatives

[baklysystems/laravel-paymob

Laravel PayMob online payment gateway package

282.4k](/packages/baklysystems-laravel-paymob)[amirasaran/zarinpal

Online Zarinpal Payment Extension For Yii2

131.9k](/packages/amirasaran-zarinpal)[lucassmacedo/omnipay-mercadopago

MercadoPago gateway for OmniPay

154.6k](/packages/lucassmacedo-omnipay-mercadopago)

PHPackages © 2026

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