Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeboxrcodehub/nagad
Laravel Nagad Payment Gateway Package. Easy to manage nagad payment system.
https://github.com/codeboxrcodehub/nagad
bd-payment laravel laravel-nagad-payment laravel-package nagad-api nagad-api-library nagad-gateway nagad-php-library nagad-php-package nagad-php-payment-gateway payment payments php
Last synced: 2 days ago
JSON representation
Laravel Nagad Payment Gateway Package. Easy to manage nagad payment system.
- Host: GitHub
- URL: https://github.com/codeboxrcodehub/nagad
- Owner: codeboxrcodehub
- Created: 2022-07-14T12:13:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-26T05:05:46.000Z (8 months ago)
- Last Synced: 2024-12-18T06:51:38.060Z (29 days ago)
- Topics: bd-payment, laravel, laravel-nagad-payment, laravel-package, nagad-api, nagad-api-library, nagad-gateway, nagad-php-library, nagad-php-package, nagad-php-payment-gateway, payment, payments, php
- Language: PHP
- Homepage: https://codeboxr.com
- Size: 34.2 KB
- Stars: 16
- Watchers: 1
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Nagad Payment Gateway for Laravel Framework/PHP project
[](https://packagist.org/packages/codeboxr/nagad)
[](https://packagist.org/packages/codeboxr/nagad)
## Features
This is a php/laravel wrapper package for [Nagad MFS](https://nagad.com.bd/)
1. [Create Payment/Take to Payment Page](https://github.com/codeboxrcodehub/nagad#1-create-payment)
2. [Verify Payment/Query Payment/Payment Details](https://github.com/codeboxrcodehub/nagad#2-verify-payment)
3. [Refund Payment](https://github.com/codeboxrcodehub/nagad#3-refund-payment)
## Requirements
- PHP >=7.4
- Laravel >= 6
## Installation
```bash
composer require codeboxr/nagad
```
### vendor publish (config)
```bash
php artisan vendor:publish --provider="Codeboxr\Nagad\NagadServiceProvider"
```
After publish config file setup your credential. you can see this in your config directory nagad.php file
```
"sandbox" => env("NAGAD_SANDBOX", true), // if true it will redirect to sandbox url
"merchant_id" => env("NAGAD_MERCHANT_ID", ""),
"merchant_number" => env("NAGAD_MERCHANT_NUMBER", ""),
"public_key" => env("NAGAD_PUBLIC_KEY", ""),
"private_key" => env("NAGAD_PRIVATE_KEY", ""),
'timezone' => 'Asia/Dhaka', // By default
"callback_url" => env("NAGAD_CALLBACK_URL", "http://127.0.0.1:8000/nagad/callback"), // By default you can change it in your callback url
"response_type" => "json" // By default json you can change response type json/html
```
### Set .env configuration
```
NAGAD_SANDBOX=true // for production use false
NAGAD_MERCHANT_ID=""
NAGAD_MERCHANT_NUMBER=""
NAGAD_PUBLIC_KEY=""
NAGAD_PRIVATE_KEY=""
NAGAD_CALLBACK_URL=""
```
## Usage
### 1. Create Payment
```
use Codeboxr\Nagad\Payment\Payment;
return (new Payment)->create($amount, $invoiceNumber) // 1st parameter is amount and 2nd is unique invoice number
```
or
```
use Codeboxr\Nagad\Facade\NagadPayment;
return NagadPayment::create($amount, $invoiceNumber);
```
### 2. Verify Payment
```
use Codeboxr\Nagad\Payment\Payment;
(new Payment)->verify($paymentRefId) // $paymentRefId which you will find callback URL request parameter
```
or
```
use Codeboxr\Nagad\Facade\NagadPayment;
NagadPayment::verify($paymentRefId);
```
### 3. Refund Payment
```
use Codeboxr\Nagad\Payment\Refund;
(new Refund)->refund($paymentRefId,$refundAmount);
```
or
```
use Codeboxr\Nagad\Facade\NagadRefund;
NagadRefund::refund($paymentRefId,$refundAmount);
```
Note: For the refund method, you have to pass two more parameters one is reference no and another
reference message
## Contributing
Contributions to the Nagad Payment Gateway package are welcome. Please note the following guidelines before submitting your pull
request.
- Follow [PSR-4](http://www.php-fig.org/psr/psr-4/) coding standards.
- Read Nagad API documentations first. Please contact with Nagad for their api documentation and sandbox access.
## License
This repository is licensed under the [MIT License](http://opensource.org/licenses/MIT).
Copyright 2022 [Codeboxr](https://codeboxr.com). We are not not affiliated with Nagad and don't give any guarantee.