├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
├── config
└── laravel-omnipay.php
└── src
├── Facades
├── MoMo
│ ├── AllInOneGateway.php
│ ├── AppInAppGateway.php
│ ├── POSGateway.php
│ └── QRCodeGateway.php
├── OnePay
│ ├── DomesticGateway.php
│ └── InternationalGateway.php
├── VNPay
│ └── Gateway.php
└── VTCPay
│ └── Gateway.php
├── Middleware
└── CompletePurchaseMiddleware.php
└── OmnipayServiceProvider.php
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | Tất cả lịch sử tiến trình phát triển thư viện
4 |
5 | ### 1.1.3
6 |
7 | + Hổ trợ PHP 8
8 |
9 | ### 1.1.2
10 |
11 | + Nâng cấp composer package `ignited/laravel-omnipay` lên phiên bản tối thiểu 3.3.
12 |
13 | ### 1.1.1
14 |
15 | + Hổ trợ Laravel 8.
16 |
17 | ### 1.1.0
18 |
19 | + Thêm lớp đối tượng `PHPViet\Laravel\Omnipay\Middleware\CompletePurchaseMiddleware` giảm nghiệp vụ xác minh tính hợp lệ của
20 | complete purchase request.
21 |
22 |
23 | ### 1.0.1
24 |
25 | + Hổ trợ Laravel 6 & 7.
26 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) PHP Viet
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
Laravel Omnipay
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 | ## Thông tin
18 |
19 | Hiện nay các cổng thanh toán trong nước có cấu trúc API rất đa dạng và ít có điểm chung,
20 | khiến cho việc chúng ta xây dựng các api-client cũng gặp nhiều khó khăn,
21 | chính vì vậy package này được sinh ra nhằm đồng bộ các phương thức của các cổng thanh toán,
22 | giúp cho việc tích hợp sẽ dễ dàng hơn, nó được thiết kế trên nền tảng [Omnipay](https://omnipay.thephpleague.com/)
23 | giúp bạn tối giản lại các tham trị khi tạo request gửi lên các cổng thanh toán.
24 | Do tất cả các cổng thanh toán đều có phương thức chung nên nó sẽ giúp cho bạn chuyển tiếp từ cổng thanh toán này sang cổng thanh toán khác đơn giản hơn.
25 |
26 | Ví dụ:
27 | ```php
28 | \MoMoAIO::purchase([
29 | 'amount' => 20000,
30 | 'returnUrl' => 'https://github.com/phpviet',
31 | 'notifyUrl' => 'https://github.com/phpviet',
32 | 'orderId' => 'Mã đơn hàng',
33 | 'requestId' => 'Mã request id, gợi ý nên xài uuid4',
34 | ])->send();
35 |
36 |
37 | \OnePayDomestic::purchase([
38 | 'AgainLink' => 'https://github.com/phpviet',
39 | 'vpc_MerchTxnRef' => microtime(false),
40 | 'vpc_ReturnURL' => 'https://github.com/phpviet',
41 | 'vpc_TicketNo' => '127.0.0.1',
42 | 'vpc_Amount' => '200000',
43 | 'vpc_OrderInfo' => 456,
44 | ])->send();
45 |
46 | \VNPay::purchase([
47 | 'vnp_TxnRef' => time(),
48 | 'vnp_OrderType' => 100000,
49 | 'vnp_OrderInfo' => time(),
50 | 'vnp_IpAddr' => '127.0.0.1',
51 | 'vnp_Amount' => 1000000,
52 | 'vnp_ReturnUrl' => 'https://github.com/phpviet',
53 | ])->send();
54 |
55 | \VTCPay::purchase([
56 | 'receiver_account' => '0963465816',
57 | 'reference_number' => microtime(false),
58 | 'amount' => 50000,
59 | 'url_return' => 'https://phpviet.org'
60 | ])->send();
61 |
62 | ```
63 |
64 | Các cổng thanh toán đang được hổ trợ tích hợp:
65 |
66 | + **[MoMo](https://momo.vn)**
67 | + **[OnePay](https://onepay.vn)**
68 | + **[VNPay](https://vnpay.vn)**
69 | + **[VTCPay](https://vtcpay.vn)**
70 |
71 |
72 | ## Cài đặt
73 |
74 | Cài đặt Laravel Omnipay thông qua [Composer](https://getcomposer.org):
75 |
76 | ```bash
77 | composer require phpviet/laravel-omnipay
78 | ```
79 |
80 | Sau khi cài đặt xong bạn cần phải publish config file để thiết lập thông số cho cổng thanh toán bạn cần tích hợp, publish thông qua câu lệnh:
81 |
82 | ```php
83 | php artisan vendor:publish --provider="PHPViet\Laravel\Omnipay\OmnipayServiceProvider" --tag="config"
84 | ```
85 |
86 | Nội dung file publish nằm trong thư mục `config/laravel-omnipay.php` của bạn như sau:
87 |
88 | ```php
89 | return [
90 | // Cấu hình cho các cổng thanh toán tại hệ thống của bạn, các cổng không xài có thể xóa cho gọn hoặc không điền.
91 | // Các thông số trên có được khi bạn đăng ký tích hợp.
92 |
93 | 'gateways' => [
94 | 'MoMoAIO' => [
95 | 'driver' => 'MoMo_AllInOne',
96 | 'options' => [
97 | 'accessKey' => '',
98 | 'secretKey' => '',
99 | 'partnerCode' => '',
100 | 'testMode' => false,
101 | ],
102 | ],
103 | 'MoMoQRCode' => [
104 | 'driver' => 'MoMo_QRCode',
105 | 'options' => [
106 | 'accessKey' => '',
107 | 'secretKey' => '',
108 | 'partnerCode' => '',
109 | 'testMode' => false,
110 | ],
111 | ],
112 | 'MoMoAIA' => [
113 | 'driver' => 'MoMo_AppInApp',
114 | 'options' => [
115 | 'accessKey' => '',
116 | 'secretKey' => '',
117 | 'partnerCode' => '',
118 | 'publicKey' => '',
119 | 'testMode' => false,
120 | ],
121 | ],
122 | 'MoMoPOS' => [
123 | 'driver' => 'MoMo_POS',
124 | 'options' => [
125 | 'accessKey' => '',
126 | 'secretKey' => '',
127 | 'partnerCode' => '',
128 | 'publicKey' => '',
129 | 'testMode' => false,
130 | ],
131 | ],
132 | 'OnePayDomestic' => [
133 | 'driver' => 'OnePay_Domestic',
134 | 'options' => [
135 | 'vpcMerchant' => '',
136 | 'vpcAccessCode' => '',
137 | 'vpcUser' => '',
138 | 'vpcPassword' => '',
139 | 'vpcHashKey' => '',
140 | 'testMode' => false,
141 | ],
142 | ],
143 | 'OnePayInternational' => [
144 | 'driver' => 'OnePay_International',
145 | 'options' => [
146 | 'vpcMerchant' => '',
147 | 'vpcAccessCode' => '',
148 | 'vpcUser' => '',
149 | 'vpcPassword' => '',
150 | 'vpcHashKey' => '',
151 | 'testMode' => false,
152 | ],
153 | ],
154 | 'VTCPay' => [
155 | 'driver' => 'VTCPay',
156 | 'options' => [
157 | 'websiteId' => '',
158 | 'securityCode' => '',
159 | 'testMode' => false,
160 | ],
161 | ],
162 | 'VNPay' => [
163 | 'driver' => 'VNPay',
164 | 'options' => [
165 | 'vnpTmnCode' => '',
166 | 'vnpHashSecret' => '',
167 | 'testMode' => false,
168 | ],
169 | ],
170 | ],
171 | ];
172 | ```
173 | ## Cách sử dụng
174 |
175 | + [Cổng thanh toán MoMo](/docs/MoMo.md)
176 | + [Cổng thanh toán OnePay](/docs/OnePay.md)
177 | + [Cổng thanh toán VNPay](/docs/VNPay.md)
178 | + [Cổng thanh toán VTCPay](/docs/VTCPay.md)
179 |
180 | ## Dành cho nhà phát triển
181 |
182 | Nếu như bạn cảm thấy thư viện chúng tôi còn thiếu sót hoặc sai sót và bạn muốn đóng góp để phát triển chung,
183 | chúng tôi rất hoan nghênh! Hãy tạo các `issue` để đóng góp ý tưởng cho phiên bản kế tiếp hoặc tạo `PR`
184 | để đóng góp phần thiếu sót hoặc sai sót. Riêng đối với các lỗi liên quan đến bảo mật thì phiền bạn gửi email đến
185 | vuongxuongminh@gmail.com thay vì tạo issue. Cảm ơn!
186 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "phpviet/laravel-omnipay",
3 | "description": "Laravel Omnipay hổ trợ tích hợp các cổng thanh toán trong nước.",
4 | "keywords": [
5 | "phpviet",
6 | "laravel-omnipay",
7 | "omnipay",
8 | "vietnam-payment-gateways",
9 | "payment-gateways"
10 | ],
11 | "homepage": "https://github.com/phpviet/laravel-omnipay",
12 | "license": "MIT",
13 | "authors": [
14 | {
15 | "name": "Vuong Xuong Minh",
16 | "email": "vuongxuongminh@gmail.com"
17 | }
18 | ],
19 | "require": {
20 | "php": "^7.1 || ^8.0",
21 | "ignited/laravel-omnipay": "^3.3",
22 | "illuminate/support": "^5.7 || ^6.0 || ^7.0 || ^8.0",
23 | "phpviet/omnipay-momo": "^1.0",
24 | "phpviet/omnipay-onepay": "^1.0",
25 | "phpviet/omnipay-vnpay": "^1.0",
26 | "phpviet/omnipay-vtcpay": "^1.0"
27 | },
28 | "require-dev": {
29 | "orchestra/testbench": "^3.7 || ^4.0 || ^5.0 || ^6.0"
30 | },
31 | "autoload": {
32 | "psr-4": {
33 | "PHPViet\\Laravel\\Omnipay\\": "src"
34 | }
35 | },
36 | "autoload-dev": {
37 | "psr-4": {
38 | "PHPViet\\Laravel\\Omnipay\\Tests\\": "tests"
39 | }
40 | },
41 | "scripts": {
42 | "test": "\"vendor/bin/phpunit\""
43 | },
44 | "config": {
45 | "sort-packages": true
46 | },
47 | "extra": {
48 | "branch-alias": {
49 | "dev-master": "1.x-dev"
50 | },
51 | "laravel": {
52 | "aliases": {
53 | "MoMoAIO": "PHPViet\\Laravel\\Omnipay\\Facades\\MoMo\\AllInOneGateway",
54 | "MoMoAIA": "PHPViet\\Laravel\\Omnipay\\Facades\\MoMo\\AppInAppGateway",
55 | "MoMoPOS": "PHPViet\\Laravel\\Omnipay\\Facades\\MoMo\\POSGateway",
56 | "MoMoQRCode": "PHPViet\\Laravel\\Omnipay\\Facades\\MoMo\\QRCodeGateway",
57 | "OnePayDomestic": "PHPViet\\Laravel\\Omnipay\\Facades\\OnePay\\DomesticGateway",
58 | "OnePayInternational": "PHPViet\\Laravel\\Omnipay\\Facades\\OnePay\\InternationalGateway",
59 | "VNPay": "PHPViet\\Laravel\\Omnipay\\Facades\\VNPay\\Gateway",
60 | "VTCPay": "PHPViet\\Laravel\\Omnipay\\Facades\\VTCPay\\Gateway"
61 | },
62 | "providers": [
63 | "PHPViet\\Laravel\\Omnipay\\OmnipayServiceProvider"
64 | ]
65 | }
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/config/laravel-omnipay.php:
--------------------------------------------------------------------------------
1 | [
8 | 'MoMoAIO' => [
9 | 'driver' => 'MoMo_AllInOne',
10 | 'options' => [
11 | 'accessKey' => '',
12 | 'secretKey' => '',
13 | 'partnerCode' => '',
14 | 'testMode' => false,
15 | ],
16 | ],
17 | 'MoMoQRCode' => [
18 | 'driver' => 'MoMo_QRCode',
19 | 'options' => [
20 | 'accessKey' => '',
21 | 'secretKey' => '',
22 | 'partnerCode' => '',
23 | 'testMode' => false,
24 | ],
25 | ],
26 | 'MoMoAIA' => [
27 | 'driver' => 'MoMo_AppInApp',
28 | 'options' => [
29 | 'accessKey' => '',
30 | 'secretKey' => '',
31 | 'partnerCode' => '',
32 | 'publicKey' => '',
33 | 'testMode' => false,
34 | ],
35 | ],
36 | 'MoMoPOS' => [
37 | 'driver' => 'MoMo_POS',
38 | 'options' => [
39 | 'accessKey' => '',
40 | 'secretKey' => '',
41 | 'partnerCode' => '',
42 | 'publicKey' => '',
43 | 'testMode' => false,
44 | ],
45 | ],
46 | 'OnePayDomestic' => [
47 | 'driver' => 'OnePay_Domestic',
48 | 'options' => [
49 | 'vpcMerchant' => '',
50 | 'vpcAccessCode' => '',
51 | 'vpcUser' => '',
52 | 'vpcPassword' => '',
53 | 'vpcHashKey' => '',
54 | 'testMode' => false,
55 | ],
56 | ],
57 | 'OnePayInternational' => [
58 | 'driver' => 'OnePay_International',
59 | 'options' => [
60 | 'vpcMerchant' => '',
61 | 'vpcAccessCode' => '',
62 | 'vpcUser' => '',
63 | 'vpcPassword' => '',
64 | 'vpcHashKey' => '',
65 | 'testMode' => false,
66 | ],
67 | ],
68 | 'VTCPay' => [
69 | 'driver' => 'VTCPay',
70 | 'options' => [
71 | 'websiteId' => '',
72 | 'securityCode' => '',
73 | 'testMode' => false,
74 | ],
75 | ],
76 | 'VNPay' => [
77 | 'driver' => 'VNPay',
78 | 'options' => [
79 | 'vnpTmnCode' => '',
80 | 'vnpHashSecret' => '',
81 | 'testMode' => false,
82 | ],
83 | ],
84 | ],
85 | ];
86 |
--------------------------------------------------------------------------------
/src/Facades/MoMo/AllInOneGateway.php:
--------------------------------------------------------------------------------
1 |
16 | *
17 | * @since 1.0.0
18 | */
19 | class AllInOneGateway extends Facade
20 | {
21 | /**
22 | * {@inheritdoc}
23 | */
24 | protected static function getFacadeAccessor(): MoMoGateway
25 | {
26 | return static::$app['omnipay']->gateway('MoMoAIO');
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/src/Facades/MoMo/AppInAppGateway.php:
--------------------------------------------------------------------------------
1 |
21 | *
22 | * @since 1.0.0
23 | */
24 | class AppInAppGateway extends Facade
25 | {
26 | /**
27 | * {@inheritdoc}
28 | */
29 | protected static function getFacadeAccessor(): MoMoGateway
30 | {
31 | return static::$app['omnipay']->gateway('MoMoAIA');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Facades/MoMo/POSGateway.php:
--------------------------------------------------------------------------------
1 |
21 | *
22 | * @since 1.0.0
23 | */
24 | class POSGateway extends Facade
25 | {
26 | /**
27 | * {@inheritdoc}
28 | */
29 | protected static function getFacadeAccessor(): MoMoGateway
30 | {
31 | return static::$app['omnipay']->gateway('MoMoPOS');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Facades/MoMo/QRCodeGateway.php:
--------------------------------------------------------------------------------
1 |
21 | *
22 | * @since 1.0.0
23 | */
24 | class QRCodeGateway extends Facade
25 | {
26 | /**
27 | * {@inheritdoc}
28 | */
29 | protected static function getFacadeAccessor(): MoMoGateway
30 | {
31 | return static::$app['omnipay']->gateway('MoMoQRCode');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Facades/OnePay/DomesticGateway.php:
--------------------------------------------------------------------------------
1 |
21 | *
22 | * @since 1.0.0
23 | */
24 | class DomesticGateway extends Facade
25 | {
26 | /**
27 | * {@inheritdoc}
28 | */
29 | protected static function getFacadeAccessor(): OnePayGateway
30 | {
31 | return static::$app['omnipay']->gateway('OnePayDomestic');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Facades/OnePay/InternationalGateway.php:
--------------------------------------------------------------------------------
1 |
21 | *
22 | * @since 1.0.0
23 | */
24 | class InternationalGateway extends Facade
25 | {
26 | /**
27 | * {@inheritdoc}
28 | */
29 | protected static function getFacadeAccessor(): OnePayGateway
30 | {
31 | return static::$app['omnipay']->gateway('OnePayInternational');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Facades/VNPay/Gateway.php:
--------------------------------------------------------------------------------
1 |
22 | *
23 | * @since 1.0.0
24 | */
25 | class Gateway extends Facade
26 | {
27 | /**
28 | * {@inheritdoc}
29 | */
30 | protected static function getFacadeAccessor(): VNPayGateway
31 | {
32 | return static::$app['omnipay']->gateway('VNPay');
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/Facades/VTCPay/Gateway.php:
--------------------------------------------------------------------------------
1 |
20 | *
21 | * @since 1.0.0
22 | */
23 | class Gateway extends Facade
24 | {
25 | /**
26 | * {@inheritdoc}
27 | */
28 | protected static function getFacadeAccessor(): VTCPayGateway
29 | {
30 | return static::$app['omnipay']->gateway('VTCPay');
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/Middleware/CompletePurchaseMiddleware.php:
--------------------------------------------------------------------------------
1 |
18 | *
19 | * @since 1.1.0
20 | */
21 | class CompletePurchaseMiddleware
22 | {
23 | /**
24 | * @param \Illuminate\Http\Request $request
25 | * @param \Closure $next
26 | * @return mixed
27 | */
28 | public function handle($request, Closure $next, string $gateway)
29 | {
30 | /** @var AbstractGateway $gateway */
31 | $gateway = app('omnipay')->gateway($gateway);
32 |
33 | if (! $gateway->supportsCompletePurchase()) {
34 | throw new \InvalidArgumentException('Gateway configured not support complete purchase method!');
35 | }
36 |
37 | try {
38 | $response = $gateway->completePurchase()->send();
39 | } catch (OmnipayException $e) {
40 | throw new BadRequestHttpException($e->getMessage());
41 | }
42 |
43 | $request->attributes->set('completePurchaseResponse', $response);
44 |
45 | return $next($request);
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/OmnipayServiceProvider.php:
--------------------------------------------------------------------------------
1 |
15 | *
16 | * @since 1.0.0
17 | */
18 | class OmnipayServiceProvider extends ServiceProvider
19 | {
20 | /**
21 | * Boot package services.
22 | */
23 | public function boot(): void
24 | {
25 | $this->publishConfigs();
26 | }
27 |
28 | /**
29 | * Publish package service configs.
30 | */
31 | protected function publishConfigs(): void
32 | {
33 | $this->publishes([
34 | __DIR__.'/../config/laravel-omnipay.php' => $this->app->configPath('laravel-omnipay.php'),
35 | ], 'config');
36 | }
37 | }
38 |
--------------------------------------------------------------------------------