Skip to content

Commit 710069b

Browse files
committed
update readme file
1 parent 5a1bc59 commit 710069b

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,71 @@
33
</p>
44

55
<h1 align="center">uPay BD Payment Gateway</h1>
6+
<p align="center" >
7+
<img src="https://img.shields.io/packagist/dt/codeboxr/upay">
8+
<img src="https://img.shields.io/packagist/stars/codeboxr/upay">
9+
</p>
10+
## Requirements
11+
12+
- PHP >=7.2
13+
- Laravel >= 6
14+
15+
## Installation
16+
17+
```bash
18+
composer require codeboxr/upay
19+
```
20+
21+
### vendor publish (config)
22+
```bash
23+
php artisan vendor:publish --provider="Codeboxr\Upay\UpayServiceProvider"
24+
```
25+
26+
After publish config file setup your credential. you can see this in your config directory upay.php file
27+
```
28+
"sandbox" => env("UPAY_SANDBOX", false), // for production use true
29+
"merchant_id" => env("UPAY_MERCHANT_ID", ""),
30+
"merchant_key" => env("UPAY_MERCHANT_KEY", ""),
31+
"merchant_code" => env("UPAY_MERCHANT_CODE", ""),
32+
"merchant_name" => env("UPAY_MERCHANT_NAME", ""),
33+
"merchant_mobile" => env("UPAY_MERCHANT_MOBILE", ""),
34+
"merchant_city" => env("UPAY_MERCHANT_CITY", ""),
35+
"merchant_category_code" => env("UPAY_CATEGORY_CODE", "9399"),
36+
"redirect_url" => env("UPAY_CALLBACK_URL", "")
37+
```
38+
39+
## Usage
40+
41+
### 1. Create Payment
42+
43+
```
44+
use Codeboxr\Upay\Facade\Payment;
45+
46+
return Payment::executePayment($amount, $invoiceId, $txnId, $date);
47+
48+
```
49+
### Example
50+
51+
```
52+
return Payment::executePayment(10, 'CBX10101', '10127373', '2022-08-26');
53+
```
54+
### 2. Query Payment
55+
56+
```
57+
use Codeboxr\Upay\Facade\Payment;
58+
59+
Payment::queryPayment($invoiceId); // Invoice ID
60+
```
61+
62+
## Contributing
63+
64+
Contributions to the uPay package are welcome. Please note the following guidelines before submitting your pull request.
65+
66+
- Follow [PSR-4](http://www.php-fig.org/psr/psr-4/) coding standards.
67+
- Read uPay API documentations first
68+
69+
## License
70+
71+
uPay package is licensed under the [MIT License](http://opensource.org/licenses/MIT).
72+
73+
Copyright 2022 [Codeboxr](https://codeboxr.com)

0 commit comments

Comments
 (0)