Skip to content

Commit f0c8ae7

Browse files
vuongxuongminhvuongxuongminh
committed
Added docs [skip ci]
1 parent d83bfc8 commit f0c8ae7

File tree

10 files changed

+908
-0
lines changed

10 files changed

+908
-0
lines changed

‎docs/MoMo.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<p align="center">
2+
<a href="https://momo.vn" target="_blank">
3+
<img src="https://avatars0.githubusercontent.com/u/36770798" height="100px">
4+
</a>
5+
<h1 align="center">Omnipay: MoMo</h1>
6+
</p>
7+
8+
Package này cung cấp cho bạn 4 loại tích hợp với công thanh toán MoMo, mỗi loại sẽ đi chung
9+
với một **Facade** tương ứng:
10+
11+
Facade | Mô tả
12+
------- | -------
13+
MoMoAIO | Hổ trợ tích hợp cổng [All In One](momo/AllInOne.md).
14+
MoMoAIA | Hổ trợ tích hợp cổng [App In App](momo/AppInApp.md).
15+
MoMoPOS | Hổ trợ tích hợp cổng [POS](momo/POS.md).
16+
MoMoQRCode | Hổ trợ tích hợp cổng [QR Code](momo/QRCode.md).
17+
18+
Tùy theo mục đích của bạn mà hãy lựa chọn gateway tương thích để kham khảo chi tiết về các
19+
gateways mời bạn truy cập vào website giới thiệu tích hợp của [MoMo](https://developers.momo.vn).

‎docs/OnePay.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<p align="center">
2+
<a href="https://onepay.vn" target="_blank">
3+
<img src="https://raw.githubusercontent.com/phpviet/omnipay-onepay/master/resources/logo.png">
4+
</a>
5+
<h1 align="center">Omnipay: OnePay</h1>
6+
</p>
7+
8+
Package này cung cấp cho bạn 2 loại tích hợp với công thanh toán OnePay, mỗi loại sẽ đi chung
9+
với một **Facade** tương ứng:
10+
11+
Facade | Mô tả
12+
------- | -------
13+
OnePayDomestic | Hổ trợ tích hợp cổng [Nội Địa](onepay/Domestic.md).
14+
OnePayInternational | Hổ trợ tích hợp cổng [Quốc Tế](onepay/International.md).
15+
16+
Tùy theo mục đích của bạn mà hãy lựa chọn gateway tương thích để kham khảo chi tiết về các
17+
gateways mời bạn truy cập vào website giới thiệu tích hợp của [OnePay](https://mtf.onepay.vn/developer).

‎docs/VNPay.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<p align="center">
2+
<a href="https://vnpay.vn" target="_blank">
3+
<img src="https://raw.githubusercontent.com/phpviet/omnipay-vnpay/master/resources/logo.png">
4+
</a>
5+
<h1 align="center">Omnipay: VNPay</h1>
6+
</p>
7+
8+
Package này cung cấp cho bạn facade `VNPay` để tương tác với cổng thanh toán.
9+
10+
### Tạo yêu cầu thanh toán:
11+
12+
```php
13+
$response = \VNPay::purchase([
14+
'vnp_TxnRef' => time(),
15+
'vnp_OrderType' => 100000,
16+
'vnp_OrderInfo' => time(),
17+
'vnp_IpAddr' => '127.0.0.1',
18+
'vnp_Amount' => 1000000,
19+
'vnp_ReturnUrl' => 'https://github.com/phpviet',
20+
])->send();
21+
22+
if ($response->isRedirect()) {
23+
$redirectUrl = $response->getRedirectUrl();
24+
25+
// TODO: chuyển khách sang trang VNPay để thanh toán
26+
}
27+
```
28+
29+
Kham khảo thêm các tham trị khi tạo yêu cầu và VNPay trả về tại [đây](https://sandbox.vnpayment.vn/apis/docs/huong-dan-tich-hop/#t%E1%BA%A1o-url-thanh-to%C3%A1n).
30+
31+
32+
### Kiểm tra thông tin `vnp_ReturnUrl` khi khách được VNPay redirect về:
33+
34+
```php
35+
$response = \VNPay::completePurchase()->send();
36+
37+
if ($response->isSuccessful()) {
38+
// TODO: xử lý kết quả và hiển thị.
39+
print $response->vnp_Amount;
40+
print $response->vnp_TxnRef;
41+
42+
var_dump($response->getData()); // toàn bộ data do VNPay gửi sang.
43+
44+
} else {
45+
46+
print $response->getMessage();
47+
}
48+
```
49+
50+
Kham khảo thêm các tham trị khi VNPay trả về tại [đây](https://sandbox.vnpayment.vn/apis/docs/huong-dan-tich-hop/#code-returnurl).
51+
52+
### Kiểm tra thông tin `IPN` do VNPay gửi sang:
53+
54+
```php
55+
$response = \VNPay::notification()->send();
56+
57+
if ($response->isSuccessful()) {
58+
// TODO: xử lý kết quả.
59+
print $response->vnp_Amount;
60+
print $response->vnp_TxnRef;
61+
62+
var_dump($response->getData()); // toàn bộ data do VNPay gửi sang.
63+
64+
} else {
65+
66+
print $response->getMessage();
67+
}
68+
```
69+
70+
Kham khảo thêm các tham trị khi VNPay gửi sang tại [đây](https://sandbox.vnpayment.vn/apis/docs/huong-dan-tich-hop/#code-ipn-url).
71+
72+
### Kiểm tra trạng thái giao dịch:
73+
74+
```php
75+
$response = \VNPay::queryTransaction([
76+
'vnp_TransDate' => 20190705151126,
77+
'vnp_TxnRef' => 1562314234,
78+
'vnp_OrderInfo' => time(),
79+
'vnp_IpAddr' => '127.0.0.1',
80+
'vnp_TransactionNo' => 496558,
81+
])->send();
82+
83+
if ($response->isSuccessful()) {
84+
// TODO: xử lý kết quả và hiển thị.
85+
print $response->getTransactionId();
86+
print $response->getTransactionReference();
87+
88+
var_dump($response->getData()); // toàn bộ data do VNPay gửi về.
89+
90+
} else {
91+
92+
print $response->getMessage();
93+
}
94+
```
95+
96+
Kham khảo thêm các tham trị khi tạo yêu cầu và VNPay trả về tại [đây](https://goo.gl/FHdM5B).
97+
98+
### Yêu cầu hoàn tiền:
99+
100+
```php
101+
$response = \VNPay::refund([
102+
'vnp_Amount' => 10000,
103+
'vnp_TransactionType' => '03',
104+
'vnp_TransDate' => 20190705151126,
105+
'vnp_TxnRef' => 32321,
106+
'vnp_OrderInfo' => time(),
107+
'vnp_IpAddr' => '127.0.0.1',
108+
'vnp_TransactionNo' => 496558,
109+
])->send();
110+
111+
if ($response->isSuccessful()) {
112+
// TODO: xử lý kết quả và hiển thị.
113+
print $response->getTransactionId();
114+
print $response->getTransactionReference();
115+
116+
var_dump($response->getData()); // toàn bộ data do VNPay gửi về.
117+
118+
} else {
119+
120+
print $response->getMessage();
121+
}
122+
```
123+
124+
Kham khảo thêm các tham trị khi tạo yêu cầu và VNPay trả về tại [đây](https://goo.gl/FHdM5B).

‎docs/VTCPay.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<p align="center">
2+
<a href="https://vtcpay.vn" target="_blank">
3+
<img src="https://raw.githubusercontent.com/phpviet/omnipay-vtcpay/master/resources/logo.png">
4+
</a>
5+
<h1 align="center">Omnipay: VTCPay</h1>
6+
</p>
7+
8+
Package này cung cấp cho bạn facade `VTCPay` để tương tác với cổng thanh toán.
9+
10+
11+
### Tạo yêu cầu thanh toán:
12+
13+
```php
14+
$response = \VTCPay::purchase([
15+
'receiver_account' => '0963465816',
16+
'reference_number' => microtime(false),
17+
'amount' => 50000,
18+
'url_return' => 'https://phpviet.org'
19+
])->send();
20+
21+
if ($response->isRedirect()) {
22+
$redirectUrl = $response->getRedirectUrl();
23+
24+
// TODO: chuyển khách sang trang VTCPay để thanh toán
25+
}
26+
```
27+
28+
Kham khảo thêm các tham trị khi tạo yêu cầu và VTCPay trả về tại [đây](https://vtcpay.vn/tai-lieu-tich-hop-website).
29+
30+
### Kiểm tra thông tin `url_return` khi khách được VTCPay redirect về:
31+
32+
```php
33+
$response = \VTCPay::completePurchase()->send();
34+
35+
if ($response->isSuccessful()) {
36+
// TODO: xử lý kết quả và hiển thị.
37+
print $response->amount;
38+
print $response->reference_number;
39+
40+
var_dump($response->getData()); // toàn bộ data do VTCPay gửi sang.
41+
42+
} else {
43+
44+
print $response->getMessage();
45+
}
46+
```
47+
48+
Kham khảo thêm các tham trị khi VTCPay trả về tại [đây](https://vtcpay.vn/tai-lieu-tich-hop-website).
49+
50+
51+
### Kiểm tra thông tin `IPN` do VTCPay gửi sang:
52+
53+
```php
54+
$response = \VTCPay::notification()->send();
55+
56+
if ($response->isSuccessful()) {
57+
// TODO: xử lý kết quả.
58+
print $response->amount;
59+
print $response->reference_number;
60+
61+
var_dump($response->getData()); // toàn bộ data do VTCPay gửi sang.
62+
63+
} else {
64+
65+
print $response->getMessage();
66+
}
67+
```
68+
69+
Kham khảo thêm các tham trị khi VTCPay gửi sang tại [đây](https://vtcpay.vn/tai-lieu-tich-hop-website).

‎docs/momo/AllInOne.md‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<p align="center">
2+
<a href="https://momo.vn" target="_blank">
3+
<img src="https://avatars0.githubusercontent.com/u/36770798" height="100px">
4+
</a>
5+
<h1 align="center">Omnipay MoMo: All In One</h1>
6+
</p>
7+
8+
9+
### Tạo yêu cầu thanh toán:
10+
11+
```php
12+
$response = \MoMoAIO::purchase([
13+
'amount' => 20000,
14+
'returnUrl' => 'http://domaincuaban.com/thanh-toan-thanh-cong/',
15+
'notifyUrl' => 'http://domaincuaban.com/ipn/',
16+
'orderId' => 'Mã đơn hàng',
17+
'requestId' => 'Mã request id, gợi ý nên xài uuid4',
18+
])->send();
19+
20+
if ($response->isRedirect()) {
21+
$redirectUrl = $response->getRedirectUrl();
22+
23+
// TODO: chuyển khách sang trang MoMo để thanh toán
24+
}
25+
```
26+
27+
Kham khảo thêm các tham trị khi tạo yêu cầu và MoMo trả về tại [đây](https://developers.momo.vn/#/docs/aio/?id=ph%c6%b0%c6%a1ng-th%e1%bb%a9c-thanh-to%c3%a1n).
28+
29+
### Kiểm tra thông tin `returnUrl` khi khách được MoMo redirect về:
30+
31+
```php
32+
$response = \MoMoAIO::completePurchase()->send();
33+
34+
if ($response->isSuccessful()) {
35+
// TODO: xử lý kết quả và hiển thị.
36+
print $response->amount;
37+
print $response->orderId;
38+
39+
var_dump($response->getData()); // toàn bộ data do MoMo gửi sang.
40+
41+
} else {
42+
43+
print $response->getMessage();
44+
}
45+
```
46+
47+
Kham khảo thêm các tham trị khi MoMo trả về tại [đây](https://developers.momo.vn/#/docs/aio/?id=th%c3%b4ng-tin-tham-s%e1%bb%91).
48+
49+
### Kiểm tra thông tin `notifyUrl` do MoMo gửi sang:
50+
51+
```php
52+
$response = \MoMoAIO::notification()->send();
53+
54+
if ($response->isSuccessful()) {
55+
// TODO: xử lý kết quả và hiển thị.
56+
print $response->amount;
57+
print $response->orderId;
58+
59+
var_dump($response->getData()); // toàn bộ data do MoMo gửi sang.
60+
61+
} else {
62+
63+
print $response->getMessage();
64+
}
65+
```
66+
67+
Kham khảo thêm các tham trị khi MoMo gửi sang tại [đây](https://developers.momo.vn/#/docs/aio/?id=th%c3%b4ng-tin-tham-s%e1%bb%91).
68+
69+
### Kiểm tra trạng thái giao dịch:
70+
71+
```php
72+
$response = \MoMoAIO::queryTransaction([
73+
'orderId' => '123',
74+
'requestId' => '456',
75+
])->send();
76+
77+
if ($response->isSuccessful()) {
78+
// TODO: xử lý kết quả và hiển thị.
79+
print $response->amount;
80+
print $response->orderId;
81+
82+
var_dump($response->getData()); // toàn bộ data do MoMo gửi về.
83+
84+
} else {
85+
86+
print $response->getMessage();
87+
}
88+
```
89+
90+
Kham khảo thêm các tham trị khi tạo yêu cầu và MoMo trả về tại [đây](https://developers.momo.vn/#/docs/aio/?id=ki%e1%bb%83m-tra-tr%e1%ba%a1ng-th%c3%a1i-giao-d%e1%bb%8bch).
91+
92+
### Yêu cầu hoàn tiền:
93+
94+
```php
95+
$response = \MoMoAIO::refund([
96+
'orderId' => '123',
97+
'requestId' => '999',
98+
'transId' => 321,
99+
'amount' => 50000,
100+
])->send();
101+
102+
if ($response->isSuccessful()) {
103+
// TODO: xử lý kết quả và hiển thị.
104+
print $response->amount;
105+
print $response->orderId;
106+
107+
var_dump($response->getData()); // toàn bộ data do MoMo gửi về.
108+
109+
} else {
110+
111+
print $response->getMessage();
112+
}
113+
```
114+
115+
Kham khảo thêm các tham trị khi tạo yêu cầu và MoMo trả về tại [đây](https://developers.momo.vn/#/docs/aio/?id=ho%c3%a0n-ti%e1%bb%81n-giao-d%e1%bb%8bch).
116+
117+
### Kiểm tra trạng thái hoàn tiền:
118+
119+
```php
120+
$response = \MoMoAIO::queryRefund([
121+
'orderId' => '123',
122+
'requestId' => '321',
123+
])->send();
124+
125+
if ($response->isSuccessful()) {
126+
// TODO: xử lý kết quả và hiển thị.
127+
print $response->amount;
128+
print $response->orderId;
129+
130+
var_dump($response->getData()); // toàn bộ data do MoMo gửi về.
131+
132+
} else {
133+
134+
print $response->getMessage();
135+
}
136+
```
137+
138+
Kham khảo thêm các tham trị khi tạo yêu cầu và MoMo trả về tại [đây](https://developers.momo.vn/#/docs/aio/?id=ki%e1%bb%83m-tra-tr%e1%ba%a1ng-th%c3%a1i-ho%c3%a0n-ti%e1%bb%81n).
139+
140+
### Phương thức hổ trợ debug:
141+
142+
Một số phương thức chung hổ trợ debug khi `isSuccessful()` trả về `FALSE`:
143+
144+
```php
145+
print $response->getCode(); // mã báo lỗi do MoMo gửi sang.
146+
print $response->getMessage(); // câu thông báo lỗi do MoMo gửi sang.
147+
```
148+
149+
Kham khảo bảng báo lỗi `getCode()` chi tiết tại [đây](https://developers.momo.vn/#/docs/aio/?id=b%e1%ba%a3ng-m%c3%a3-l%e1%bb%97i).

0 commit comments

Comments
 (0)