README

Features

This is a php/laravel wrapper package for Nagad MFS

Requirements

PHP >=7.4
Laravel >= 6

Installation

composer require codeboxr/nagad

vendor publish (config)

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

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

use Codeboxr\Nagad\Facade\NagadPayment;

NagadPayment::verify($paymentRefId);

3. Refund Payment

use Codeboxr\Nagad\Payment\Refund;

(new Refund)->refund($paymentRefId,$refundAmount);

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 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.

codeboxr / nagad

Maintainers

Details