Download the PHP package mainul12501/bkash-payment-b2c without Composer

Laravel bKash Gateway

Laravel 11, 12, and 13 package for bKash payment gateway integrations, covering the public flows exposed in bKash's current developer docs and guides.

Features

• Checkout (URL based) Regular sale payment Auth and capture Void Query payment Search transaction Refund
• Tokenized checkout Grant token Refresh token Create agreement Execute agreement Query agreement Cancel agreement Create payment Execute payment Confirm payment Query payment Search transaction Refund Refund status helper
• Disbursement and wallet operations B2C payout to customer Organization balance query Intra-account transfer B2B merchant payout B2B payout initiation
• Integration helpers Automatic token caching and refresh retry Raw request escape hatch for undocumented or newly-added endpoints Webhook payload parsing and optional shared-secret check

Requirements

• PHP 8.2+
• Laravel 11, 12, or 13

Installation

Configuration

Default config file: config/bkash.php

Minimal .env example:

The sandbox and production URLs have sensible defaults in the config file. Override them only if bKash changes the endpoints:

If bKash gives you different credentials per service, set the service-specific keys:

Usage

Facade entry point

Checkout payment

The public checkout create-payment reference shows these required body fields:

• amount
• currency
• intent
• merchantInvoiceNumber

Example:

Execute, capture, query, void

Search transaction

Refund

Tokenized checkout

The tokenized reference is structured differently from checkout. The package exposes both generic and convenience methods so you can mirror the exact request body from your bKash onboarding docs.

Tokenized agreement and payment queries

Tokenized refund and refund status

Note:

• The current bKash public guide for refund status is not modeled in the same embedded OpenAPI schema as the main reference pages.
• The guide currently shows {{tokenized_url}}/v2/tokenized-checkout/refund/payment/status.
• If your merchant onboarding doc uses a different refund-status path, override it per call:

B2C payout

The B2C payout guide documents these required fields:

• amount
• currency
• merchantInvoiceNumber
• receiverMSISDN

Organization balance

Intra-account transfer

The public guide documents transferType as one of:

• Collection2Disbursement
• Disbursement2Collection

B2B payout

The public B2B payout guide is a two-step flow.

Step 1: initiate

Step 2: B2B payout

Raw request escape hatch

This package intentionally includes a low-level method because bKash sometimes documents flows in guide pages before the embedded API reference catches up.

For absolute paths outside the service base version:

Webhooks

The package provides a simple parser and optional shared-secret header check.

Response handling

All gateway methods return Mainul12501\Bkash\Support\BkashResponse.

Error handling

Failed HTTP responses throw Mainul12501\Bkash\Exceptions\BkashRequestException.

Notes

• bKash's product overview currently states TLS 1.2+ only.
• Sandbox and production use different hostnames.
• Checkout and tokenized references expose different schemas and path styles.
• B2B payout is documented in guide pages instead of the same embedded OpenAPI model used by checkout and tokenized reference pages.
• Subscriptions and add-wallet are mentioned in product overview, but their public API details were not exposed in the fetched docs set above. Use Bkash::raw() when bKash provides merchant-specific endpoint details.

Package API Summary

Bkash::checkout()

• grantToken(): array
• refreshToken(): array
• createPayment(array $payload): BkashResponse
• executePayment(string $paymentID): BkashResponse
• capturePayment(string $paymentID): BkashResponse
• queryPayment(string $paymentID): BkashResponse
• voidPayment(string $paymentID): BkashResponse
• searchTransaction(string $trxID): BkashResponse
• refund(array $payload): BkashResponse
• b2cPayment(array $payload): BkashResponse
• organizationBalance(): BkashResponse
• intraAccountTransfer(array $payload): BkashResponse

Bkash::tokenized()

• grantToken(): array
• refreshToken(): array
• create(array $payload): BkashResponse
• createAgreement(array $payload): BkashResponse
• createPayment(array $payload): BkashResponse
• execute(array $payload): BkashResponse
• executeAgreement(array $payload): BkashResponse
• executePayment(array $payload): BkashResponse
• queryAgreement(array|string $agreement): BkashResponse
• cancelAgreement(array|string $agreement): BkashResponse
• confirmPayment(string $confirmationType, array $payload): BkashResponse
• queryPayment(array $payload): BkashResponse
• searchTransaction(array|string $trx): BkashResponse
• refund(array $payload): BkashResponse
• refundStatus(array $payload, ?string $path = null): BkashResponse

Bkash::payouts()

• grantToken(): array
• refreshToken(): array
• initiate(array $payload): BkashResponse
• b2b(array $payload): BkashResponse

Bkash::webhooks()

• parse(string $payload): array
• fromRequest(Request $request): array
• hasMatchingSecret(Request $request, ?string $expected = null, ?string $header = null): bool
• assertMatchingSecret(Request $request, ?string $expected = null, ?string $header = null): void