پکیج درگاه پرداخت برای پی اچ پی

این پکیج برای پرداخت آنلاین توسط درگاه‌های مختلف در پی اچ پی ایجاد شده است.

این پکیج با درگاه‌های پرداخت مختلفی کار میکنه. در صورتی که درگاه مورد نظرتون رو در لیست درایورهای موجود پیدا نکردید می‌تونید برای درگاهی که استفاده می‌کنید درایور مورد نظرتون رو بسازید.

داکیومنت فارسی
english documents
中文文档

در صورتی که از این پکیج خوشتون آمده و ازش استفاده می‌کنید می‌تونید با پرداخت مبلغ اندکی من رو حمایت کنید تا این پکیج رو بیشتر توسعه بدم و درگاه‌های جدیدتری بهش اضافه کنم.

به منظور کمک مالی کلیک کنید 😎

درصورتی که از Laravel استفاده میکنید میتونید از پکیج shetabit/payment استفاده کنید.

لیست محتوا

درایور های موجود
نصب
تنظیمات
طریقه استفاده
درایور آفلاین (برای تست)
تغییرات
مشارکت کننده ها
امنیت
توسعه دهندگان
لایسنس

درایورهای موجود

اسان پرداخت ✔️
آقای پرداخت ✔️
آتی‌پی ✔️
ازکی وام (پرداخت اقساطی) ✔️
به‌پرداخت (mellat) ✔️
دیجی پی ✔️
اعتبارینو (پرداخت اقساطی) ✔️
ایدی پی ✔️
ایرانکیش ✔️
نکست پی ✔️
پارسیان ✔️
پاسارگاد ✔️
پی آی ار ✔️
پی پال (به زودی در ورژن بعدی اظافه میشود)
پی پینگ ✔️
پی استار ✔️
پولام ✔️
سداد (بانک ملی) ✔️
سامان ✔️
سپهر (بانک صادرات) ✔️
والتا (پرداخت اقساطی) ✔️
یک پی ✔️
زرین پال ✔️
زیبال ✔️
سپرده ✔️
درایورهای دیگر ساخته خواهند شد یا اینکه بسازید و درخواست merge بدید.

در صورتی که درایور مورد نظرتون موجود نیست, می‌تونید برای درگاه پرداخت موردنظرتون درایور بسازید.

نصب

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

$ composer require shetabit/multipay

تنظیمات

a. ابتدا فایل حاوی تنظیمات را از مسیر config/payment.php به درون پروژه خود کپی کنید. (فایل تنظیمات رو میتونید از مسیر vendor/shetabit/multipay/config/payment.php نیز پیدا کرده و کپی کنید)

b. درون فایل تنظیمات در قسمت default driver می‌توانید درایوری که قصد استفاده از ان را دارید قرار دهید تا تمامی پرداخت ها از آن طریق انجام شود.

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

سپس تنظیمات مرتبط با درایوری که قصد استفاده از ان را دارید انجام دهید

'drivers' => [
    'zarinpal' => [
        // Fill all 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'),
    ],
    ...
]

c. سپس از روی کلاس Payment یک نمونه ایجاد کنید و تنظیمات را به درون آن ارسال کنید:

    use Shetabit\Multipay\Payment;

    // load the config file from your project
    $paymentConfig = require('path/to/payment.php');

    $payment = new Payment($paymentConfig);

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

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

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

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

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

// 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');

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

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

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

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

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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 میتوانیم کاربر را به صفحه ی پرداخت بانک هدایت کنیم:

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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();

// 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();

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

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

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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();
}

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

ایجاد درایور دلخواه:

برای ایجاد درایور جدید ابتدا نام (اسم) درایوری که قراره بسازید رو به لیست درایور ها اضافه کنید و لیست تنظیات مورد نیاز را نیز مشخص کنید.

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

کلاس درایوری که قصد ساختنش رو دارید باید کلاس Shetabit\Multipay\Abstracts\Driver رو به ارث ببره.

به عنوان مثال:

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() : RedirectionForm {
        // 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.
        $url = $payUrl;
        $inputs = [];
        $method = 'GET';

        return $this->redirectWithForm($url, $inputs, $method);
    }
    
    // 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');
    }
}

بعد از اینکه کلاس درایور خودتون رو ایجاد کردید به فایل Config/payment.php برید و درایور خودتون رو در قسمت map اضافه کنید.

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

نکته: دقت کنید کلیدی که قسمت map قرار میدهید باید همنام با نامی باشد که در قسمت drivers قرار داده اید.

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

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

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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: به کمک این متد می‌توانید به صورت مستقیم هزینه صورتحساب را مشخص کنید

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// Purchase (we set invoice to null).
$payment->callbackUrl($url)->amount(1000)->purchase(
    null, 
    function($driver, $transactionId) {
    // We can store $transactionId in database.
	}
);

via: به منظور تغییر درایور در هنگام اجرای برنامه مورد استفاده قرار میگیرد

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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: به منظور تغییر تنظیمات در هنگام اجرای برنامه مورد استفاده قرار میگیرد

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

// load the config file from your project
$paymentConfig = require('path/to/payment.php');

$payment = new Payment($paymentConfig);


// 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.
	}
);

رویدادها:

نکته اول: تمامی listener ها به صورت global تنظیم خواهند شد و برای تمامی پرداخت ها اعمال میشوند.

نکته دوم: اگه میخواید listener های شما به درستی کار کنند باید حتما آنها را تا قبل از فراخوانی شدن رویدادها تنظیم کرده باشید.

بهتر است listener ها را در جایی از برنامه قرار دهید که همیشه قبل از کار کردن با درگاه های پرداخت اجرا شوند و تنظیم شوند.

سه مورد از رویداد وجود دارند که میتوانید برای آنها listener تنظیم کنید:

purchase
pay
verify.

purchase: این رویداد بعد از purchase شدن صورتحساب فراخوانی میشود.

// add purchase event listener
Payment::addPurchaseListener(function($driver, $invoice) {
    echo $driver;
    echo $invoice;
});

pay: این رویداد بعد از اینکه متد pay فراخوانی شود اتفاق می افتد. در این حالت صورتحساب اماده ی پرداخت می باشد.

// add pay event listener
Payment::addPayListener(function($driver, $invoice) {
    echo 'first listener';
});

// we can add multiple listeners
Payment::addPayListener(function($driver, $invoice) {
    echo 'second listener';
});

verify: این رویداد هنگامی که صورتحساب موفقیت آمیز verify شود فراخوانی میشود.

// شما میتوانید چندین لیستنر داشته باشید و همچنین آنها را حذف کنید

$firstListener = function($driver, $invoice) {
    echo 'first listener';
};

$secondListener = function($driver, $invoice) {
    echo 'second listener';
};

Payment::addVerifyListener($firstListener);
Payment::addVerifyListener($secondListener);

// remove first listener
Payment::removeVerifyListener($firstListener);

// if we call remove listener without any arguments, it will remove all listeners
Payment::removeVerifyListener(); // remove all verify listeners :D

درایور آفلاین

(Local driver)

این درایور برای شبیه سازی روند خرید از درگاه اینترنتی استفاده میشود.

شروع روند پرداخت مانند بقیه درایورها است.

$invoice = (new Invoice)->amount(10000);
$payment->via('local')->purchase($invoice, function($driver, $transactionId) {
    // یک شناسه پرداخت به صورت اتفاقی تولید و برگردانده میشود
})->pay()->render();

بعد از صدا زدن متد render یک فرم HTML‍ با دکمه های پرداخت موفق و پرداخت ناموفق نمایش داده میشود. این دکمه‌ها یک پرداخت موفق یا ناموفق درگاه بانکی واقعی را شبیه سازی میکنند و پس از آن مسیر را به callbackUrl انتقال میدهند.

در هر دو حالت پارامتر trasactionId به انتهای مسیر callbackUrl اضافه شده و قابل دسترسی است.

بعد از انتقال به callbackUrl امکان اعتبارسنجی تراکنش وجود دارد.

$receipt = $payment->via('local')->verify();

در صورت پرداخت موفق، رسید پرداخت با مشخصات ساختگی تولید میشود.

[
'orderId' => // شماره سفارش (ساختگی) 
'traceNo' => // شماره پیگیری (ساختگی) (جهت ذخیره در دیتابیس)
'referenceNo' => // شماره تراکنش که در مرحله قبل تولید شده بود (transactionId)
'cardNo' => // چهار رقم آخر کارت (ساختگی)
]

در صورتی که پرداخت ناموفق (یا لغو تراکنش)، یک استثنا از نوع `InvalidPaymentException` ایجاد میشود که حاوی پیام لغو تراکنش توسط کاربر است.

تعدادی از امکانات درایور توسط مقدارهایی که به invoice داده میشوند، قابل تنظیم است.

پارامترهای قابل تنظیم

$invoice->detail([
    // setting this value will cause `purchase` method to throw an `PurchaseFailedException` 
    // to simulate when a gateway can not initialize the payment.
        'failedPurchase' => 'custom message to decribe the error',

    // Setting this parameter will be shown in payment form.
        'orderId' => 4444,
]);

ظاهر فرم

بعضی از مشخصات ظاهری فرم پرداخت نمایش داده شده از طریق پارامترهای درایور `local` در فایل `payment.php` قابل تغییر هستند.

'local' => [
    // default callback url of the driver
    'callbackUrl' => '/callback',

    // main title of the form
    'title' => 'Test gateway',
    
    // a description to show under the title for more clarification
    'description' => 'This gateway is for using in development environments only.',
    
    // custom label to show as order No.
    'orderLabel' => 'Order No.',
    
    // custom label to show as payable amount
    'amountLabel' => 'Payable amount',
    
    // custom label of successful payment button
    'payButton' => 'Successful Payment',
    
    // custom label of cancel payment button
    'cancelButton' => 'Cancel Payment',
],

تغییرات

برای مشاهده آخرین تغییرات انجام شده در پکیج قسمت تغییرات را بررسی کنید.

مشارکت کننده ها

برای مشاهده لیست مشارکت کننده ها CONTRIBUTING and CONDUCT را بررسی کنید.

امنیت

در صورتی که مشکل امنیتی در پکیج پیدا کردید به منظور رفع مشکل با ایمیل khanzadimahdi@gmail.com در ارتباط باشید.

توسعه دهندگان

Mahdi khanzadi
All Contributors

لایسنس

توسعه و تولید تحت لایسنس MIT است. برای اطلاعات بیشتر فایل لایسنس را مطالعه کنید.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README-FA.md

README-FA.md

پکیج درگاه پرداخت برای پی اچ پی

لیست محتوا

درایورهای موجود

نصب

تنظیمات

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

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

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

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

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

ایجاد درایور دلخواه:

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

`config`: به منظور تغییر تنظیمات در هنگام اجرای برنامه مورد استفاده قرار میگیرد

رویدادها:

درایور آفلاین

`پارامترهای قابل تنظیم`

`ظاهر فرم`

تغییرات

مشارکت کننده ها

امنیت

توسعه دهندگان

لایسنس

Files

README-FA.md

Latest commit

History

README-FA.md

File metadata and controls

پکیج درگاه پرداخت برای پی اچ پی

لیست محتوا

درایورهای موجود

نصب

تنظیمات

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

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

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

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

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

ایجاد درایور دلخواه:

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

config: به منظور تغییر تنظیمات در هنگام اجرای برنامه مورد استفاده قرار میگیرد

رویدادها:

درایور آفلاین

پارامترهای قابل تنظیم

ظاهر فرم

تغییرات

مشارکت کننده ها

امنیت

توسعه دهندگان

لایسنس

`config`: به منظور تغییر تنظیمات در هنگام اجرای برنامه مورد استفاده قرار میگیرد

`پارامترهای قابل تنظیم`

`ظاهر فرم`