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

ActiveLibrary

payro/payment
=============

Laravel Payment Gateway for Payro24

09PHP

Since Jul 13Pushed 4y ago1 watchersCompare

[ Source](https://github.com/payro24/php-laravel-payro-package)[ Packagist](https://packagist.org/packages/payro/payment)[ RSS](/packages/payro-payment/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependenciesVersions (1)Used By (0)

[![](resources/images/logo.png)](resources/images/logo.png)

پیرو۲۴
======

[](#پیرو۲۴)

این پکیج برای پرداخت انلاین توسط درگاه پرداخت پیرو در لاراول ایجاد شده است.

نصب
---

[](#نصب)

نصب با استفاده از کامپوزر

```
$ composer require payro/payment
```

تنظیمات
-------

[](#تنظیمات)

سپس دستور `php artisan vendor:publish` را اجرا کنید تا فایل تنظیمات درون دایرکتوری `config/payment.php` ساخته شود

درصورتی که از `Laravel 5.5` یا ورژن های بالاتر استفاده میکنید نیازی به انجام تنظیمات `providers` و `alias` نخواهید داشت.

درون فایل `config/app.php` دستورات زیر را وارد کنید

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

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

سپس تنظیمات درگاه پرداخت پیرو را انجام دهید

```
'drivers' => [
        'payro24' => [
            'apiPurchaseUrl' => 'https://api.payro24.ir/v1.0/payment',
            'apiPaymentUrl' => 'https://payro24.ir/',
            'apiVerificationUrl' => 'https://api.payro24.ir/v1.0/payment/verify',
            'merchantId' => '',
            'callbackUrl' => 'http://yoursite.com/path/to',
            'description' => 'payment in '.config('app.name'),
            'sandbox' => false, // set it to true for test environments
        ]
]
```

طریقه استفاده
-------------

[](#طریقه-استفاده)

در تمامی پرداخت ها اطلاعات پرداخت درون صورتحساب شما نگهداری میشود. برای استفاده از پکیج ابتدا نحوه ی استفاده از کلاس `Invoice` به منظور کار با صورتحساب ها را توضیح میدهیم.

#### کار با صورتحساب ها

[](#کار-با-صورتحساب-ها)

قبل از انجام هرکاری نیاز به ایجاد یک صورتحساب دارید. برای ایجاد صورتحساب میتوانید از کلاس `Invoice` استفاده کنید.

درون کد خودتون به شکل زیر عمل کنید:

```
# On the top of the file.
use Payro\Payment\Invoice;
...

# create new invoice
$invoice = new Invoice;

# set invoice amount
$invoice->amount(1000);
$invoice->detail(['name1' => 'detail1','name2' => 'detail2']);
```

متدهای موجود برای کار با صورتحساب ها:

- `uuid` : یک ایدی یونیک برای صورتحساب تنظیم میکند
- `getUuid` : ایدی یونیک صورتحساب را برمیگرداند
- `detail` : توضیحات یا مواردی که مرتبط به صورتحساب است را به صورتحساب اظافه میکند
- `getDetails` : تمامی موارد مرتبطی که به صورتحساب افزوده شده است را برمیگرداند
- `amount` : مقدار هزینه ای که باید پرداخت شود را مشخص میکند
- `getAmount` : هزینه ی صورتحساب را برمیگرداند
- `transactionId` : شماره تراکنش صورتحساب را مشخص میکند
- `getTransactionId` : شماره تراکنش صورتحساب را برمیگرداند
- `getDriver` : درایور انتخاب شده را برمیگرداند

#### ثبت درخواست برای پرداخت صورتحساب

[](#ثبت-درخواست-برای-پرداخت-صورتحساب)

به منظور پرداخت تمامی صورتحساب ها به یک شماره تراکنش بانکی یا `transactionId` نیاز خواهیم داشت. با ثبت درخواست به منظور پرداخت میتوان شماره تراکنش بانکی را دریافت کرد:

```
# On the top of the file.
use Payro\Payment\Invoice;
use Payro\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
	}
);
```

#### پرداخت صورتحساب

[](#پرداخت-صورتحساب)

با استفاده از شماره تراکنش یا `transactionId` میتوانیم کاربر را به صفحه ی پرداخت بانک هدایت کنیم:

```
# On the top of the file.
use Payro\Payment\Invoice;
use Payro\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's page.
return Payment::purchase($invoice, function($driver, $transactionId) {
    // store transactionId in database, we need it to verify payment in future.
})->pay();

# do all things together 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 future
	}
)->pay();
```

#### اعتبار سنجی پرداخت

[](#اعتبار-سنجی-پرداخت)

بعد از پرداخت شدن صورتحساب توسط کاربر, بانک کاربر را به یکی از صفحات سایت ما برمیگردونه و ما با اعتبار سنجی میتونیم متوجه بشیم کاربر پرداخت رو انجام داده یا نه!

```
# On the top of the file.
use Payro\Payment\Facade\Payment;
use Payro\Payment\Exceptions\InvalidPaymentException;
...

# you need to verify the payment to insure the invoice has been paid successfully
// we use transaction's id to verify payments
// its a good practice to add invoice's amount.
try {
	$receipt = Payment::amount(1000)->transactionId($transaction_id)->verify();

    // you can show payment's referenceId to user
    echo $receipt->getReferenceId();

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

در صورتی که پرداخت توسط کاربر به درستی انجام نشده باشه یک استثنا از نوع `InvalidPaymentException` ایجاد میشود که حاوی پیام متناسب با پرداخت انجام شده است.

#### متدهای سودمند

[](#متدهای-سودمند)

- `callbackUrl` : با استفاده از این متد به صورت داینامیک میتوانید ادرس صفحه ای که بعد از پرداخت انلاین کاربر به ان هدایت میشود را مشخص کنید

```
  # On the top of the file.
  use Payro\Payment\Invoice;
  use Payro\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` : به کمک این متد میتوانید به صورت مستقیم هزینه صورتحساب را مشخص کنید

```
  # On the top of the file.
  use Payro\Payment\Invoice;
  use Payro\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
  	}
  );
```

#### رویدادها

[](#رویدادها)

شما میتوانید درون برنامه خود دو رویداد را ثبت و ضبط کنید

- **InvoicePurchasedEvent** : هنگامی که یک پرداخت به درستی ثبت شود این رویداد اتفاق میافتد.
- **InvoiceVerifiedEvent** : هنگامی که یک پرداخت به درستی وریفای شود این رویداد اتفاق میافتد

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity29

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/f0dbbbed5b2d5c81e3174e268754986cef79efc86d088661d2988a1d0fbfd759?d=identicon)[matinrz](/maintainers/matinrz)

---

Top Contributors

[![matiinrz](https://avatars.githubusercontent.com/u/66595133?v=4)](https://github.com/matiinrz "matiinrz (18 commits)")

### Embed Badge

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

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

PHPackages © 2026

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