DEV Community: Ariful Islam

Use Nagad API PHP SDK to PHP Application for Taking Payment

Ariful Islam — Mon, 27 Jun 2022 19:37:03 +0000

Nagad is a popular mobile banking service in Bangladesh. A large number of people around the country are using nagad. For paying payment using nagad wallet you need to have nagad account and website/app owner need to have merchant account. Merchant can take payment easily by implementing api provided by nagad. Here is the github link for this package https://github.com/arif98741/nagadApi

PHP is a popular programming language. To use nagad in php based application its needed to implement API. Here I've made a php sdk library called xenon/nagad-api that will reduce your headache regarding nagad api. Here I am guiding you how to use nagad php sdk library in your php application.

Step 1:
composer require xenon/nagad-api

Step 2:

Example Code


<?php

use Xenon\NagadApi\Helper;
use Xenon\NagadApi\Base;

require 'vendor/autoload.php';

//all configuration are used here for demo purpose.
//for use in dev mode use 'development'
//for use in production mode use 'production'
$config = [
    'NAGAD_APP_ENV' => 'development', //development|production
    'NAGAD_APP_LOG' => '1',
    'NAGAD_APP_ACCOUNT' => '016XXXXXXXX', //demo
    'NAGAD_APP_MERCHANTID' => '6800000025', //demo
    'NAGAD_APP_MERCHANT_PRIVATE_KEY' => 'MIIEvFAAxN1qfKiRiCL720FtrI7QL7fvQ==',
    'NAGAD_APP_MERCHANT_PG_PUBLIC_KEY' => 'MIIBIjANBc54jjMJoP2toR9fGmQV7y9fzj6TIz9SFfsTQOugHkhyRzzhvZisiKzOAAWNX8RMpG+iqQi4p9W9VrmmiCfFDmLFnMrwhncnMsvlXB8QSJCq2irrx3HG0SJJCbS5+atz+E1iqO8QaPJ05snxv82Mf4NlZ4gZK0Pq/VvJ20lSkR+0nk+s/v3BgIyle78wjZP1vWLU4wIDAQAB',
    'NAGAD_APP_TIMEZONE' => 'Asia/Dhaka',
];

$nagad = new Base($config, [
    'amount' => 100,
    'invoice' => Helper::generateFakeInvoice(15, true),
    'merchantCallback' => 'https://example.com/payment/success/id=4',
]);
//way 1 - use for website
$status = $nagad->payNow($nagad); //will redirect to payment url of Nagad

//way 2 - useful for rest api or graphQL 
$paymentUrl = $nagad->payNowWithoutRedirection($nagad); //will return payment url like below. You can use that url and do whatever u want to get payment from clients. 
//
`http://sandbox.mynagad.com:10060/check-out/MDYyODAwNTcyNTYxNi42ODMwMDIwMDcxMDQyMjUuOU5PTEFVNkVaWkdUWVRBLmJiZGMyNTE3MTVmZTNiNjIzN2Zk`

//after that use below method for extracting payment response that will return an array
$response = Helper::successResponse('https://example.com/payment/success/id=4/?merchant=683XXXX225&order_id=CKH060JXXXXXFRA2&payment_ref_id=MXXXXXXXXtIMDYwSjFRSlBRMUZSQTIuMTg0NTE2Yzc3ZmEzNmEwZTJlZjk=&status=Success&status_code=00_0000_000&message=Successful%20Transaction&payment_dt=20211123235008&issuer_payment_ref=MTEyMzIzNDg1NzUwOS42ODMwMDIwMDcxMDQyMjUuQ0tIMDYwSjFRSlBRMUZSQTIuMTg0NTE2Yzc3ZmEzNmEwZTJlZjk=');
Array
(
    [merchant] => 683XXXX225
    [order_id] => CKH060JXXXXXFRA2
    [payment_ref_id] => MXXXXXXXXtIMDYwSjFRSlBRMUZSQTIuMTg0NTE2Yzc3ZmEzNmEwZTJlZjk=
    [status] => Success
    [status_code] => 00_0000_000
    [message] => Successful Transaction
    [payment_dt] => 20211123235008
    [issuer_payment_ref] => MTEyMzIzNDg1NzUwOXXXXXtIMDYwSjFRSlBRMUZSQTIuMTg0NTE2Yzc3ZmEzNmEwZTJlZjk=
)


//For payment verification use below method. You will then get below json as response. 
echo $config->verifyPayment($response['payment_ref_id']);
## Payment verification Response
{
    merchantId: "683XXXX225",
    orderId: "CKH060JXXXXXFRA2",
    paymentRefId: "MXXXXXXXXtIMDYwSjFRSlBRMUZSQTIuMTg0NTE2Yzc3ZmEzNmEwZTJlZjk=",
    amount: "16",
    clientMobileNo: "016****5428",
    merchantMobileNo: "01XXXXXXX10",
    orderDateTime: "2021-11-23 23:48:22.0",
    issuerPaymentDateTime: "2021-11-23 23:50:08.0",
    issuerPaymentRefNo: "000XXXW",
    additionalMerchantInfo: null,
    status: "Success",
    statusCode: "000",
    cancelIssuerDateTime: null,
    cancelIssuerRefNo: null
}

Information:

Sandbox

Need sandbox details for sandbox testing. Check your email that you have got from nagad authority
Use sandbox details such as pgpublickey, privatekey, merchant-id for sandbox testing
You need to register a mobile number for sandbox testing. Contact with your account manager for doing this
You should test environment before going to live

Live

Need production details for production final. You will get through email
Your server ip/domain should be whitelisted before running in production

https://auth.mynagad.com:10900/authentication-service-provider-1.0/login

Step 1:
In the Merchant Portal, Go to Merchant Integration Details under Merchant Management Menu.
You will get the Merchant ID which is your Merchant ID for Integration.

Then, Click on “Key Generate” and
Download the Merchant Private Key and Merchant Public Key.

Step 2:
Go to Merchant Integration under Merchant Management Menu.
Put your Call Back URL and Upload the Merchant Public Key which you have downloaded in Step 1. Add and Submit!

For more tech blog visit https://programmingmindset.com

Bangladeshi Courier Company Api Integration in Laravel Using Xenon Multicourier Package

Ariful Islam — Tue, 14 Jun 2022 20:44:13 +0000

We are developers and we have to work on several projects. For several projects we have to integrate different company’s api for courier parcel booking, shipping and also tracking. I aslo faced that. After faching that awkward problem for a long time I motivated my mind to make a common library/package that will solve this issues like my previously released package Xenon/Laravelbdsms

Here I developed Xenon/MultiCourier for solving this hassel that will fixed coding structure for all providers though their api are different. Your duty is to change api credentials provided by your courier company such E-courier, Pathao, Steadfast, Paperfly, Redx; Follow the below steps for integrating this package in your project easily

Step 1:

composer require xenon/multicourier

Step 2:
Then, publish the package

php artisan vendor:publish --provider=Xenon\MultiCourier\MultiCourierServiceProvider

Step 3:
Set .env configuration for individual couriers . Here E-courier and Pathao for example

PATHAO_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
PATHAO_USERNAME="xxxx@example.com"
PATHAO_PASSWORD="xxxxxx"
PATHAO_GRANT_TYPE="password"
ECOURIER_API_KEY='xxx'
ECOURIER_API_SECRET='xxx'
ECOURIER_USER_ID='xxxx'
ECOURIER_ENVIRONMENT='xxxx'

Otherwise, if you want more control, you can use the underlying sender object. This will not touch any laravel facade or service provider.

Here below are sample code for interacting with provider’s api

Get Location

use Xenon\MultiCourier\Provider\ECourier;
use Xenon\MultiCourier\Courier;


$courier = Courier::getInstance();
$courier->setProvider(ECourier::class, 'local'); /* local/production */
$courier->setConfig([
    'API-KEY' => 'xxx',
    'API-SECRET' => 'xxxx',
    'USER-ID' => 'xxxx',
]);
$courier->setParams(['city'=>'Dhaka']);
$thanas = $courier->getThanas(); //get thana
$cities = $courier->getCities(); //get city

 
Place Order
//place order
use Xenon\MultiCourier\Provider\ECourier;
use Xenon\MultiCourier\Courier;


$courier = Courier::getInstance();
$courier->setProvider(ECourier::class, 'local'); /* local/production */
$courier->setConfig([
    'API-KEY' => 'xxx',
    'API-SECRET' => 'xxx',
    'USER-ID' => 'xxx',
]);
$orderData = array(
    'recipient_name' => 'XXXXX',
    'recipient_mobile' => '017XXXXX',
    'recipient_city' => 'Dhaka',
    'recipient_area' => 'Badda',
    'recipient_thana' => 'Badda',
    'recipient_address' => 'Full Address',
    'package_code' => '#XXXX',
    'product_price' => '1500',
    'payment_method' => 'COD',
    'recipient_landmark' => 'DBBL ATM',
    'parcel_type' => 'BOX',
    'requested_delivery_time' => '2019-07-05',
    'delivery_hour' => 'any',
    'recipient_zip' => '1212',
    'pick_hub' => '18490',
    'product_id' => 'DAFS',
    'pick_address' => 'Gudaraghat new mobile',
    'comments' => 'Please handle carefully',
    'number_of_item' => '3',
    'actual_product_price' => '1200',
    'pgwid' => 'XXX',
    'pgwtxn_id' => 'XXXXXX'
);

$courier->setParams($orderData);
$response = $courier->placeOrder();

For accesing to repo and all method list visit github link from here https://github.com/arif98741/multicourier

Send Message to Bangladeshi Mobile Using Laravel

Ariful Islam — Fri, 02 Jul 2021 16:41:53 +0000

LaravelBDSms is a package for sending sms/otp to Bangladeshi mobile number. This package is built specially for laravel. You view github repo from here https://github.com/arif98741/laravelbdsms ; Using this package it is possible to send message using several Bangladeshi SMS Gateways such as....

BDBulkSMS
BulkSMSBD
Dianahost
MDLSMS
Metronet
OnnoRokomSMS
SSLSms

Installation

composer require xenon/laravelbdsms

Currently this package supports laravel 5.4*, 5.6*, 6., 7. and 8.* also.

As you have installed laravelbdsms, you are now able to use this package anywhere in your project. See the below example for sending sms DianaHost Sms Gateway

Send SMS Using Dianahost

use Xenon\LaravelBDSms\Provider\DianaHost;
use Xenon\LaravelBDSms\Sender;


$sender = Sender::getInstance();
$sender->setProvider(DianaHost::class);
$sender->setMobile('017XXYYZZAA');
$sender->setMessage('This is test message');
$sender->setQueue(true); //if you want to sent sms from queue
$sender->setConfig(
   [
       'api_key' => 'api_key_goes_here',
       'type' => 'text',
       'senderid' => 'approved_send_id',
   ]
);

$status = $sender->send();

Send SMS Using SSL SMS

use Xenon\LaravelBDSms\Provider\Ssl;
use Xenon\LaravelBDSms\Sender;

$sender = Sender::getInstance();
$sender->setProvider(Ssl::class); 
$sender->setMobile('017XXYYZZAA');
//$sender->setMobile(['017XXYYZZAA','018XXYYZZAA']);
$sender->setMessage('helloooooooo boss!');
$sender->setQueue(true); //if you want to sent sms from queue
$sender->setConfig(
   [
       'api_token' => 'api token goes here',
       'sid' => 'text',
       'csms_id' => 'sender_id'
   ]
);
$status = $sender->send();

Simply use the facade

use Xenon\LaravelBDSms\Facades\SMS;

SMS::shoot('017XXYYZZAA', 'helloooooooo boss!');

SMS::shoot(['017XXYYZZAA','018XXYYZZAA'], 'helloooooooo boss!');` //for Ssl Sms Gateway Only

use Xenon\LaravelBDSms\Facades\SMS;
use Xenon\LaravelBDSms\Provider\Ssl;

SMS::shootWithQueue("01XXXXXXXXX",'test sms');
SMS::via(Ssl::class)->shootWithQueue("01XXXXXXXXX",'test sms');

Or, if you want to send message with queue. This queue will be added in your jobs table. Message will be sent as soon as job is run.

use Xenon\LaravelBDSms\Facades\SMS;
use Xenon\LaravelBDSms\Provider\Ssl;

SMS::shootWithQueue("01XXXXXXXXX",'test sms');
SMS::via(Ssl::class)->shootWithQueue("01XXXXXXXXX",'test sms'); //you can change provider using via method

Log Generate

You can generate log in database for every sms api request and save in database. For doing this. Follow below points
1. Be confirm you have completed **step-2** and **step-3**
2. Run command ``php artisan migrate``. This will create ``lbs_log`` table in your database
3. Go to your project directory  and locate ``config/sms.php``
4. Find and make true 'sms_log' => true

Note: Setting configuration for sending sms is very necessary . If you don't configure instance before calling send() method , you will get exception for passing using setConfig() method.

Currently Supported SMS Gateways

Provider	Credentials Required For Sending SMS	Status	Comment	Contact
AjuraTech	apikey, secretkey , callerID	Done	-	-
Adn	api_key, type, senderid	Done	-	-
Banglalink	userID, passwd , sender	Done	-	-
BDBulkSMS	token	Done	-	-
BoomCast	masking , userName , password	Done	-	-
BulksmsBD	api_key,senderid	Done	-	-
DianaHost	api_key, type, senderid	Done	-	-
DianaSMS	ApiKey, ClientId, SenderId	Done	-	-
Esms	api_token, sender_id	Done	-	-
ElitBuzz	api_key, type, senderid	Done	not tested yet in live	-
Infobip	user, password	Done	not tested yet in live	-
MDL	api_key, type, senderid	Done	not tested yet in live	-
Metronet	api_key, mask	Done	-	-
MimSms	api_key, type, senderid	Done	-	-
Mobireach	Username,Password, From	Done	-	-
NovocomBD	ApiKey , ClientId , SenderId	Done	-	-
OnnoRokomSMS	userName, userPassword, type, maskName, campaignName	Done	not tested yet in live	-
RedmoITSms	api_token, sender_id	Support closed	-
SmartLabSMS	user, password, sender	Done	-	-
SmsinBD	api_token, senderid	Done	01777-333677	-
SmsQ	sender_id, client_id, api_key	Done		-
SMSNet24	user_id, user_password, route_id(optional), sms_type_id(optional)	Done	-	admin2@digitallabbd.com, +880 1705 691269, +880 1733393 712
SmsNoc	sender_id, bearer_token	Done	-
Sslsms	api_token, sid, csms_id	Done	-	-
Tense	user, password, campaign, masking	Done	-	-
TwentyFourSmsBD	apiKey, sender_id	Done	-	-
Trubosms	api_token, sender_id	Done	-	-
Viatech	api_key, mask	Done	-	-

If you feel bore to read documentation then you can watch youtube video as well. If you benefitted using this package you are highly requested to follow me at Github