PHPackages                             signalads-co/payment - 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. signalads-co/payment

ActiveLibrary[Payment Processing](/categories/payments)

signalads-co/payment
====================

Laravel Payment Gateway Integration Package

00PHP

Since Sep 10Pushed 3y agoCompare

[ Source](https://github.com/signalads-co/payment)[ Packagist](https://packagist.org/packages/signalads-co/payment)[ RSS](/packages/signalads-co-payment/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

[![](resources/images/payment.png?raw=true)](resources/images/payment.png?raw=true)

Laravel Payment Gateway
=======================

[](#laravel-payment-gateway)

[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Latest Version on Packagist](https://camo.githubusercontent.com/70434e9d319f2c8287a85e485e5a1f7f393f9d0bb906824e480ba60ae7cfe466/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73686574616269742f7061796d656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/shetabit/payment)[![Total Downloads on Packagist](https://camo.githubusercontent.com/ec10d773fd881dbc17e7a06d30a59bddf5438bd39c04c0d8d026ac33dcecf754/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73686574616269742f7061796d656e742e7376673f636f6c6f723d253233463138267374796c653d666c61742d737175617265)](https://packagist.org/packages/shetabit/payment)[![StyleCI](https://camo.githubusercontent.com/989b01de4b424f9f244948dd6bbcfa58f982fb618289b5f44764d0fc2b0df546/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3136393934383736322f736869656c643f6272616e63683d6d6173746572)](https://github.styleci.io/repos/169948762)[![Maintainability](https://camo.githubusercontent.com/db454fba258cbdcfd594a3a0e7e849ba7844d11ac19dc083770ddb5756b71a30/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f65366138306231373239386362346663623536642f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/shetabit/payment/maintainability)[![Quality Score](https://camo.githubusercontent.com/3239e0201103bfe20b1fb590c3b59f7d2cf637cf5a0efcb19746f03b76c0a9b5/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f73686574616269742f7061796d656e742e7376673f6c6162656c3d436f64652532305175616c697479267374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/shetabit/payment)

This is a Laravel Package for Payment Gateway Integration. This package supports `Laravel 5.8+`.

[Donate me](https://yekpay.me/mahdikhanzadi) if you like this package 😎 ![:bowtie:](https://github.githubassets.com/images/icons/emoji/bowtie.png ":bowtie:")

For PHP integration you can use [shetabit/multipay](https://github.com/shetabit/multipay) package.

> This packages works with multiple drivers, and you can create custom drivers if you can't find them in the [current drivers list](#list-of-available-drivers) (below list).

- [داکیومنت فارسی](README-FA.md)
- [English documents](README.md)
- [中文文档](README-ZH.md)

List of contents
================

[](#list-of-contents)

- [Laravel Payment Gateway](#laravel-payment-gateway)
- [List of contents](#list-of-contents)
- [List of available drivers](#list-of-available-drivers)
    - [Install](#install)
    - [Configure](#configure)
    - [How to use](#how-to-use)
        - [Working with invoices](#working-with-invoices)
        - [Purchase invoice](#purchase-invoice)
        - [Pay invoice](#pay-invoice)
        - [Verify payment](#verify-payment)
        - [Useful methods](#useful-methods)
        - [Create custom drivers:](#create-custom-drivers)
        - [Events](#events)
    - [Change log](#change-log)
    - [Contributing](#contributing)
    - [Security](#security)
    - [Credits](#credits)
    - [License](#license)

List of available drivers
=========================

[](#list-of-available-drivers)

- [asanpardakht](https://asanpardakht.ir/) ✔️
- [atipay](https://www.atipay.net/) ✔️
- [behpardakht (mellat)](http://www.behpardakht.com/) ✔️
- [digipay](https://www.mydigipay.com/) ✔️
- [idpay](https://idpay.ir/) ✔️
- [irankish](http://irankish.com/) ✔️
- [nextpay](https://nextpay.ir/) ✔️
- [parsian](https://www.pec.ir/) ✔️
- [pasargad](https://bpi.ir/) ✔️
- [payir](https://pay.ir/) ✔️
- [paypal](http://www.paypal.com/) (will be added soon in next version)
- [payping](https://www.payping.ir/) ✔️
- [paystar](http://paystar.ir/) ✔️
- [poolam](https://poolam.ir/) ✔️
- [sadad (melli)](https://sadadpsp.ir/) ✔️
- [saman](https://www.sep.ir) ✔️
- [sepehr (saderat)](https://www.sepehrpay.com/) ✔️
- [yekpay](https://yekpay.com/) ✔️
- [zarinpal](https://www.zarinpal.com/) ✔️
- [zibal](https://www.zibal.ir/) ✔️
- [sepordeh](https://sepordeh.com/) ✔️
- [sizpay](https://www.sizpay.ir/) ✔️
- Others are under way.

**Help me to add the gateways below by creating `pull requests`**

- stripe
- authorize
- 2checkout
- braintree
- skrill
- payU
- amazon payments
- wepay
- payoneer
- paysimple

> you can create your own custom drivers if it does not exist in the list, read the `Create custom drivers` section.

Install
-------

[](#install)

Via Composer

```
$ composer require shetabit/payment
```

Configure
---------

[](#configure)

If you are using `Laravel 5.5` or higher then you don't need to add the provider and alias. (Skip to b)

a. In your `config/app.php` file add these two lines.

```
// In your providers array.
'providers' => [
    ...
    Shetabit\Payment\Provider\PaymentServiceProvider::class,
],

// In your aliases array.
'aliases' => [
    ...
    'Payment' => Shetabit\Payment\Facade\Payment::class,
],
```

b. then run `php artisan vendor:publish` to publish `config/payment.php` file in your config directory.

In the config file you can set the `default driver` to use for all your payments. But you can also change the driver at runtime.

Choose what gateway you would like to use in your application. Then make that as default driver so that you don't have to specify that everywhere. But, you can also use multiple gateways in a project.

```
// Eg. if you want to use zarinpal.
'default' => 'zarinpal',
```

Then fill the credentials for that gateway in the drivers array.

```
'drivers' => [
    'zarinpal' => [
        // Fill in the credentials here.
        'apiPurchaseUrl' => 'https://www.zarinpal.com/pg/rest/WebGate/PaymentRequest.json',
        'apiPaymentUrl' => 'https://www.zarinpal.com/pg/StartPay/',
        'apiVerificationUrl' => 'https://www.zarinpal.com/pg/rest/WebGate/PaymentVerification.json',
        'merchantId' => '',
        'callbackUrl' => 'http://yoursite.com/path/to',
        'description' => 'payment in '.config('app.name'),
    ],
    ...
]
```

How to use
----------

[](#how-to-use)

your `Invoice` holds your payment details, so initially we'll talk about `Invoice` class.

#### Working with invoices

[](#working-with-invoices)

before doing any thing you need to use `Invoice` class to create an invoice.

In your code, use it like the below:

```
// At the top of the file.
use Shetabit\Multipay\Invoice;
...

// Create new invoice.
$invoice = new Invoice;

// Set invoice amount.
$invoice->amount(1000);

// Add invoice details: There are 4 syntax available for this.
// 1
$invoice->detail(['detailName' => 'your detail goes here']);
// 2
$invoice->detail('detailName','your detail goes here');
// 3
$invoice->detail(['name1' => 'detail1','name2' => 'detail2']);
// 4
$invoice->detail('detailName1','your detail1 goes here')
        ->detail('detailName2','your detail2 goes here');
```

available methods:

- `uuid`: set the invoice unique id
- `getUuid`: retrieve the invoice current unique id
- `detail`: attach some custom details into invoice
- `getDetails`: retrieve all custom details
- `amount`: set the invoice amount
- `getAmount`: retrieve invoice amount
- `transactionId`: set invoice payment transaction id
- `getTransactionId`: retrieve payment transaction id
- `via`: set a driver we use to pay the invoice
- `getDriver`: retrieve the driver

#### Purchase invoice

[](#purchase-invoice)

In order to pay the invoice, we need the payment transactionId. We purchase the invoice to retrieve transaction id:

```
// At the top of the file.
use Shetabit\Multipay\Invoice;
use Shetabit\Payment\Facade\Payment;
...

// Create new invoice.
$invoice = (new Invoice)->amount(1000);

// Purchase the given invoice.
Payment::purchase($invoice,function($driver, $transactionId) {
	// We can store $transactionId in database.
});

// Purchase method accepts a callback function.
Payment::purchase($invoice, function($driver, $transactionId) {
    // We can store $transactionId in database.
});

// You can specify callbackUrl
Payment::callbackUrl('http://yoursite.com/verify')->purchase(
    $invoice,
    function($driver, $transactionId) {
    	// We can store $transactionId in database.
	}
);
```

#### Pay invoice

[](#pay-invoice)

After purchasing the invoice, we can redirect the user to the bank payment page:

```
// At the top of the file.
use Shetabit\Multipay\Invoice;
use Shetabit\Payment\Facade\Payment;
...

// Create new invoice.
$invoice = (new Invoice)->amount(1000);
// Purchase and pay the given invoice.
// You should use return statement to redirect user to the bank page.
return Payment::purchase($invoice, function($driver, $transactionId) {
    // Store transactionId in database as we need it to verify payment in the future.
})->pay()->render();

// Do all things together in a single line.
return Payment::purchase(
    (new Invoice)->amount(1000),
    function($driver, $transactionId) {
    	// Store transactionId in database.
        // We need the transactionId to verify payment in the future.
	}
)->pay()->render();

// Retrieve json format of Redirection (in this case you can handle redirection to bank gateway)
return Payment::purchase(
    (new Invoice)->amount(1000),
    function($driver, $transactionId) {
    	// Store transactionId in database.
        // We need the transactionId to verify payment in the future.
	}
)->pay()->toJson();
```

#### Verify payment

[](#verify-payment)

When user has completed the payment, the bank redirects them to your website, then you need to **verify your payment** in order to ensure the `invoice` has been **paid**.

```
// At the top of the file.
use Shetabit\Payment\Facade\Payment;
use Shetabit\Multipay\Exceptions\InvalidPaymentException;
...

// You need to verify the payment to ensure the invoice has been paid successfully.
// We use transaction id to verify payments
// It is a good practice to add invoice amount as well.
try {
	$receipt = Payment::amount(1000)->transactionId($transaction_id)->verify();

    // You can show payment referenceId to the user.
    echo $receipt->getReferenceId();

    ...
} catch (InvalidPaymentException $exception) {
    /**
    	when payment is not verified, it will throw an exception.
    	We can catch the exception to handle invalid payments.
    	getMessage method, returns a suitable message that can be used in user interface.
    **/
    echo $exception->getMessage();
}
```

#### Useful methods

[](#useful-methods)

- ###### `callbackUrl`: can be used to change callbackUrl on the runtime.

    [](#callbackurl-can-be-used-to-change-callbackurl-on-the-runtime)

    ```
    // At the top of the file.
    use Shetabit\Multipay\Invoice;
    use Shetabit\Payment\Facade\Payment;
    ...

    // Create new invoice.
    $invoice = (new Invoice)->amount(1000);

    // Purchase the given invoice.
    Payment::callbackUrl($url)->purchase(
        $invoice,
        function($driver, $transactionId) {
        // We can store $transactionId in database.
    	}
    );
    ```
- ###### `amount`: you can set the invoice amount directly

    [](#amount-you-can-set-the-invoice-amount-directly)

    ```
    // At the top of the file.
    use Shetabit\Multipay\Invoice;
    use Shetabit\Payment\Facade\Payment;
    ...

    // Purchase (we set invoice to null).
    Payment::callbackUrl($url)->amount(1000)->purchase(
        null,
        function($driver, $transactionId) {
        // We can store $transactionId in database.
    	}
    );
    ```
- ###### `via`: change driver on the fly

    [](#via-change-driver-on-the-fly)

    ```
    // At the top of the file.
    use Shetabit\Multipay\Invoice;
    use Shetabit\Payment\Facade\Payment;
    ...

    // Create new invoice.
    $invoice = (new Invoice)->amount(1000);

    // Purchase the given invoice.
    Payment::via('driverName')->purchase(
        $invoice,
        function($driver, $transactionId) {
        // We can store $transactionId in database.
    	}
    );
    ```
- ###### `config`: set driver configs on the fly

    [](#config-set-driver-configs-on-the-fly)

    ```
    // At the top of the file.
    use Shetabit\Multipay\Invoice;
    use Shetabit\Payment\Facade\Payment;
    ...

    // Create new invoice.
    $invoice = (new Invoice)->amount(1000);

    // Purchase the given invoice with custom driver configs.
    Payment::config('mechandId', 'your mechand id')->purchase(
        $invoice,
        function($driver, $transactionId) {
        // We can store $transactionId in database.
    	}
    );

    // Also we can change multiple configs at the same time.
    Payment::config(['key1' => 'value1', 'key2' => 'value2'])->purchase(
        $invoice,
        function($driver, $transactionId) {
        // We can store $transactionId in database.
    	}
    );
    ```

#### Create custom drivers:

[](#create-custom-drivers)

First you have to add the name of your driver, in the drivers array and also you can specify any config parameters you want.

```
'drivers' => [
    'zarinpal' => [...],
    'my_driver' => [
        ... // Your Config Params here.
    ]
]
```

Now you have to create a Driver Map Class that will be used to pay invoices. In your driver, You just have to extend `Shetabit\Payment\Abstracts\Driver`.

Eg. You created a class: `App\Packages\PaymentDriver\MyDriver`.

```
namespace App\Packages\PaymentDriver;

use Shetabit\Multipay\Abstracts\Driver;
use Shetabit\Multipay\Exceptions\InvalidPaymentException;
use Shetabit\Multipay\{Contracts\ReceiptInterface, Invoice, Receipt};

class MyDriver extends Driver
{
    protected $invoice; // Invoice.

    protected $settings; // Driver settings.

    public function __construct(Invoice $invoice, $settings)
    {
        $this->invoice($invoice); // Set the invoice.
        $this->settings = (object) $settings; // Set settings.
    }

    // Purchase the invoice, save its transactionId and finaly return it.
    public function purchase() {
        // Request for a payment transaction id.
        ...

        $this->invoice->transactionId($transId);

        return $transId;
    }

    // Redirect into bank using transactionId, to complete the payment.
    public function pay() {
        // It is better to set bankApiUrl in config/payment.php and retrieve it here:
        $bankUrl = $this->settings->bankApiUrl; // bankApiUrl is the config name.

        // Prepare payment url.
        $payUrl = $bankUrl.$this->invoice->getTransactionId();

        // Redirect to the bank.
        return redirect()->to($payUrl);
    }

    // Verify the payment (we must verify to ensure that user has paid the invoice).
    public function verify(): ReceiptInterface {
        $verifyPayment = $this->settings->verifyApiUrl;

        $verifyUrl = $verifyPayment.$this->invoice->getTransactionId();

        ...

        /**
			Then we send a request to $verifyUrl and if payment is not valid we throw an InvalidPaymentException with a suitable message.
        **/
        throw new InvalidPaymentException('a suitable message');

        /**
        	We create a receipt for this payment if everything goes normally.
        **/
        return new Receipt('driverName', 'payment_receipt_number');
    }
}
```

Once you create that class you have to specify it in the `payment.php` config file `map` section.

```
'map' => [
    ...
    'my_driver' => App\Packages\PaymentDriver\MyDriver::class,
]
```

**Note:-** You have to make sure that the key of the `map` array is identical to the key of the `drivers` array.

#### Events

[](#events)

You can listen for 2 events

- **InvoicePurchasedEvent**: Occurs when an invoice is purchased (after purchasing invoice is done successfully).
- **InvoiceVerifiedEvent**: Occurs when an invoice is verified successfully.

Change log
----------

[](#change-log)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has been changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Mahdi khanzadi](https://github.com/khanzadimahdi)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity24

Early-stage or recently created project

 Bus Factor1

Top contributor holds 74.9% 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/1abf08d922d5d82823c448f3a623db4a06d2b55d88b56678c40b3e97b841fae8?d=identicon)[signalads](/maintainers/signalads)

---

Top Contributors

[![khanzadimahdi](https://avatars.githubusercontent.com/u/6291970?v=4)](https://github.com/khanzadimahdi "khanzadimahdi (125 commits)")[![roshedgostarandev1](https://avatars.githubusercontent.com/u/52368299?v=4)](https://github.com/roshedgostarandev1 "roshedgostarandev1 (15 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (4 commits)")[![parsagholipour](https://avatars.githubusercontent.com/u/57809920?v=4)](https://github.com/parsagholipour "parsagholipour (3 commits)")[![mobinzk](https://avatars.githubusercontent.com/u/2981528?v=4)](https://github.com/mobinzk "mobinzk (3 commits)")[![atipaydev](https://avatars.githubusercontent.com/u/91889745?v=4)](https://github.com/atipaydev "atipaydev (1 commits)")[![hamog](https://avatars.githubusercontent.com/u/11465084?v=4)](https://github.com/hamog "hamog (1 commits)")[![hatamiarash7](https://avatars.githubusercontent.com/u/16325641?v=4)](https://github.com/hatamiarash7 "hatamiarash7 (1 commits)")[![Mdhesari](https://avatars.githubusercontent.com/u/28428724?v=4)](https://github.com/Mdhesari "Mdhesari (1 commits)")[![miladified](https://avatars.githubusercontent.com/u/50750755?v=4)](https://github.com/miladified "miladified (1 commits)")[![miladnouri](https://avatars.githubusercontent.com/u/3003901?v=4)](https://github.com/miladnouri "miladnouri (1 commits)")[![mohammadv184](https://avatars.githubusercontent.com/u/77800167?v=4)](https://github.com/mohammadv184 "mohammadv184 (1 commits)")[![mokhosh](https://avatars.githubusercontent.com/u/6499685?v=4)](https://github.com/mokhosh "mokhosh (1 commits)")[![muhammadmp97](https://avatars.githubusercontent.com/u/17279395?v=4)](https://github.com/muhammadmp97 "muhammadmp97 (1 commits)")[![na3r](https://avatars.githubusercontent.com/u/760537?v=4)](https://github.com/na3r "na3r (1 commits)")[![seyedmr](https://avatars.githubusercontent.com/u/32652363?v=4)](https://github.com/seyedmr "seyedmr (1 commits)")[![AfshinEfati](https://avatars.githubusercontent.com/u/39827008?v=4)](https://github.com/AfshinEfati "AfshinEfati (1 commits)")[![tu6ge](https://avatars.githubusercontent.com/u/4115242?v=4)](https://github.com/tu6ge "tu6ge (1 commits)")[![alimousavi71](https://avatars.githubusercontent.com/u/25837589?v=4)](https://github.com/alimousavi71 "alimousavi71 (1 commits)")[![amaleky](https://avatars.githubusercontent.com/u/37160903?v=4)](https://github.com/amaleky "amaleky (1 commits)")

### Embed Badge

![Health badge](/badges/signalads-co-payment/health.svg)

```
[![Health](https://phpackages.com/badges/signalads-co-payment/health.svg)](https://phpackages.com/packages/signalads-co-payment)
```

###  Alternatives

[omnipay/paypal

PayPal gateway for Omnipay payment processing library

3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto

Biblioteca com boletos para o laravel

626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle

This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money.

1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php

2Checkout PHP Library

83740.3k2](/packages/2checkout-2checkout-php)[smhg/sepa-qr-data

Generate QR code data for SEPA payments

61717.2k5](/packages/smhg-sepa-qr-data)[omnipay/dummy

Dummy driver for the Omnipay payment processing library

271.2M33](/packages/omnipay-dummy)

PHPackages © 2026

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