BKash Payment Gateway for Laravel

✨ Features

🛠️ Requirements

📦 Installation

composer require programmerhasan/bkash

⚙️ Vendor publish (config)

php artisan vendor:publish --provider="ProgrammerHasan\Bkash\BkashServiceProvider" --tag="config"

<?php
return [
 /*
 |--------------------------------------------------------------------------
 | Enable or Disable bKash Log
 |--------------------------------------------------------------------------
 | Logging is only recommended in sandbox/testing mode.
 | In production, keep logging disabled to avoid exposing sensitive payment data.
 | Logs will be saved in the /storage/logs/laravel.log file.
 |
 | Usage:
 | - Sandbox: BKASH_SANDBOX=true → logs enabled
 | - Production: BKASH_SANDBOX=false → logs disabled
 */
 "bkash_log_enabled" => env("BKASH_SANDBOX", false),
 "bkash_sandbox" => env("BKASH_SANDBOX", false),
 "bkash_username" => env("BKASH_USERNAME"),
 "bkash_password" => env("BKASH_PASSWORD"),
 "bkash_app_key" => env("BKASH_APP_KEY"),
 "bkash_app_secret" => env("BKASH_APP_SECRET"),
 "bkash_base_url_sandbox" => "https://tokenized.sandbox.bka.sh/v1.2.0-beta/tokenized",
 "bkash_base_url_production" => "https://tokenized.Pay.bka.sh/v1.2.0-beta/tokenized",
 "bkash_callback_url" => env("BKASH_CALLBACK_URL", "http://127.0.0.1:8000/bkash/callback"),
];

📝 Set .env configuration

 BKASH_SANDBOX=true
 BKASH_USERNAME = ''
 BKASH_PASSWORD = ''
 BKASH_APP_KEY = ''
 BKASH_APP_SECRET = ''
 BKASH_CALLBACK_URL='Your defined Callback URl //default Callback Url => http://127.0.0.1:8000/bkash/callback'

📝 Enable or Disable bKash Log

"bkash_log_enabled" => env("BKASH_SANDBOX", false),

🚀 Usage

Publish a route

php artisan vendor:publish --provider="ProgrammerHasan\Bkash\BkashServiceProvider" --tag="routes"

Publish a controller

php artisan vendor:publish --provider="ProgrammerHasan\Bkash\BkashServiceProvider" --tag="controllers"

You can override the routes

Route::group(['middleware' => ['web']], static function () {
 // Payment routes for bKash
 Route::get('/bkash/payment', [BkashPaymentController::class, 'index']);
 Route::get('/bkash/create-payment', [BkashPaymentController::class, 'createPayment'])->name('bkash.payment.create');
 Route::get('/bkash/callback', [BkashPaymentController::class, 'callBack'])->name('bkash.payment.callback');
 Route::get("bkash/failed", [BkashPaymentController::class, 'failed'])->name('bkash.payment.fail');
 Route::get("bkash/success", [BkashPaymentController::class, 'success'])->name('bkash.payment.success');
 // Search payment
 Route::get('/bkash/search/{trxID}', [BkashPaymentController::class, 'searchTnx'])->name('bkash.payment.search');
 // Refund payment routes
 Route::get('/bkash/refund', [BkashPaymentController::class, 'refund'])->name('bkash.payment.refund');
 Route::get('/bkash/refund/status', [BkashPaymentController::class, 'refundStatus'])->name('bkash.payment.refund.status');
});

Use route('bkash.payment.create') in blade

<form action="{{ route('bkash.payment.create') }}" method="POST">
 @csrf
 <button type="submit">Pay with bkash</button>
 </form>

Checkout (URL Based)

1. Create Payment

public function createPayment(Request $request)
{
 $request->validate([
 'payment_uid' => 'required',
 'amount' => 'required',
 'invoice_no' => 'required',
 ]);
 
 $data = [
 'payerReference' => $request->get('payment_uid'), // your payments table uid
 'amount' => $request->get('amount'),
 'merchantInvoiceNumber' => $request->get('invoice_no'),
 'callbackURL' => $request->get('bkash_callback_url'), // optional
 ];
 $response = (array) BkashPayment::create($data);
 if (isset($response['bkashURL'])) return redirect()->away($response['bkashURL']);
 else return redirect()->back()->with('error-alert2', $response['statusMessage']);
}

Create payment response

array[
 "statusCode" => "0000"
 "statusMessage" => "Successful"
 "paymentID" => "Your payment id"
 "bkashURL" => "https://sandbox.payment.bkash.com/redirect/tokenized/?paymentID=your_payment_id&hash=your_hash"
 "callbackURL" => "base_url/bkash/callback"
 "successCallbackURL" => "base_url/bkash/callback?paymentID=your_payment_id&status=success"
 "failureCallbackURL" => "base_url/bkash/callback?paymentID=your_payment_id&status=failure"
 "cancelledCallbackURL" => "base_url/bkash/callback?paymentID=your_payment_id&status=cancel"
 "amount" => "100"
 "intent" => "sale"
 "currency" => "BDT"
 "paymentCreateTime" => "2025-07-22T02:16:57:784 GMT+0600"
 "transactionStatus" => "Initiated"
 "merchantInvoiceNumber" => "merchant_invoice_no"
]

2. Add callback function

public function callback(Request $request)
{
 // Callback request params
 // paymentID=your_payment_id&status=success&apiVersion=1.2.0-beta
 // using paymentID find the account number for sending params
 
 $status = $request->input('status');
 $paymentId = $request->input('paymentID');
 if ($status === 'success')
 {
 $response = BkashPayment::verify($paymentId);
 if ($response->statusCode !== '0000')
 {
 return BkashPayment::failed($response->statusMessage);
 }
 if (isset($response->transactionStatus)&&($response->transactionStatus=='Completed'||$response->transactionStatus=='Authorized'))
 {
 //Database Insert Operation
 return BkashPayment::success($response->trxID."({$response->transactionStatus})");
 }
 else if($response->transactionStatus=='Initiated')
 {
 return BkashPayment::failed("Try Again");
 }
 }
 else
 {
 return BkashPayment::failed($status);
 }
}

Execute payment response

{
 "statusCode":"0000",
 "statusMessage":"Successful",
 "paymentID":"your_payment_id",
 "payerReference":"your_ref_id",
 "customerMsisdn":"customer_msi",
 "trxID":"your_tnx_id",
 "amount":"100",
 "transactionStatus":"Completed",
 "paymentExecuteTime":"2023-01-23T02:04:05:736 GMT+0600",
 "currency":"BDT",
 "intent":"sale"
}

Query payment response

{
 "paymentID":"your_payment_id",
 "mode":"0011",
 "paymentCreateTime":"2023-01-23T02:01:06:713 GMT+0600",
 "paymentExecuteTime":"2023-01-23T02:04:05:736 GMT+0600",
 "amount":"100",
 "currency":"BDT",
 "intent":"sale",
 "merchantInvoice":"merchant_inv_no",
 "trxID":"tnx_no",
 "transactionStatus":"Completed",
 "verificationStatus":"Complete",
 "statusCode":"0000",
 "statusMessage":"Successful",
 "payerReference":"pay_ref"
}

3. Search Transaction

public function searchTnx($trxID)
{
 return BkashPayment::searchTransaction($trxID);
}

Response

 {
 "trxID":"tnx_no",
 "initiationTime":"2023-01-23T12:06:05:000 GMT+0600",
 "completedTime":"2023-01-23T12:06:05:000 GMT+0600",
 "transactionType":"bKash Tokenized Checkout via API",
 "customerMsisdn":"customer_msi",
 "transactionStatus":"Completed",
 "amount":"20",
 "currency":"BDT",
 "organizationShortCode":"og_short_code",
 "statusCode":"0000",
 "statusMessage":"Successful"
 }

4. Refund Transaction

public function refund(Request $request)
{
 $paymentID = 'Your payment id';
 $trxID = 'your transaction no';
 $amount = 5;
 $reason = 'this is test reason';
 $sku = 'abc';
 return BkashPayment::refund($paymentID, $trxID, $amount, $reason, $sku);
}

Response

 {
 "statusCode":"0000",
 "statusMessage":"Successful",
 "originalTrxID":"or_tnx_no",
 "refundTrxID":"refund_tnx",
 "transactionStatus":"Completed",
 "amount":"5",
 "currency":"BDT",
 "charge":"0.00",
 "completedTime":"2023-01-23T15:53:29:120 GMT+0600"
 }

5. Refund status check

public function refundStatus(Request $request)
{
 $paymentID = 'Your payment id';
 $trxID = 'your transaction no';
 return BkashPayment::refundStatus($paymentID, $trxID);
}

Response

{
 "statusCode":"0000",
 "statusMessage":"Successful",
 "originalTrxID":"ori_tx",
 "refundTrxID":"ref_tx",
 "transactionStatus":"Completed",
 "amount":"5",
 "currency":"BDT",
 "charge":"0.00",
 "completedTime":"2023-01-23T15:53:29:120 GMT+0600"
}

Auth & Capture (URL)

Create Payment

$request['payerReference'] = $paymentUid;
$request['amount'] = $amount;
$request['merchantInvoiceNumber'] = $paymentUid;
$request['callbackURL'] = $onBkashCallbackURL;
$response = BkashPayment::create($request);
return redirect($response->bkashURL);

Capture

BkashPayment::capture($paymentID);

Void

BkashPayment::void($paymentID);

Required APIs

Tokenized Checkout (v2) Demo

License