PHPackages                             payguard/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. payguard/sdk

ActiveLibrary[Payment Processing](/categories/payments)

payguard/sdk
============

Official PHP SDK for PayGuard Payment Orchestration Platform

v1.0.1(1mo ago)06MITPHPPHP ^8.0

Since Jul 15Pushed 1mo agoCompare

[ Source](https://github.com/abefimrs/payguard-payguard-php)[ Packagist](https://packagist.org/packages/payguard/sdk)[ Docs](https://app.sourcemonkey.online)[ RSS](/packages/payguard-sdk/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

payguard-payguard-php
=====================

[](#payguard-payguard-php)

PayGuard PHP SDK
================

[](#payguard-php-sdk)

Accept payments via bKash, Nagad, TAP and more through one unified API — without per-transaction commission.

Installation
------------

[](#installation)

```
composer require payguard/sdk
```

Quick Start
-----------

[](#quick-start)

```
use PayGuard\PayGuard;
use PayGuard\Exceptions\PayGuardException;

$pg = new PayGuard('your-api-key');
```

Create & Initiate Payment
-----------------------------

[](#create--initiate-payment)

### bKash Payment

[](#bkash-payment)

```
// 1. Create transaction
$transaction = $pg->createTransaction([
    'mfs_connection_id' => 1,          // Your bKash connection ID
    'amount'            => 500,        // BDT
    'reference_id'      => 'ORDER-123', // Your order ID (optional, idempotent)
    'customer_number'   => '01700000000',
    'customer_name'     => 'John Doe',
    'callback_url'      => 'https://yoursite.com/ipn', // IPN endpoint
]);

// 2. Initiate bKash payment
$payment = $pg->initiateBkash($transaction->getId());

// 3. Redirect customer to bKash checkout
header('Location: ' . $payment->getCheckoutUrl());
exit;
```

### Nagad Payment

[](#nagad-payment)

```
$transaction = $pg->createTransaction([
    'mfs_connection_id' => 2,
    'amount'            => 300,
    'customer_number'   => '01700000000',
]);

$payment = $pg->initiateNagad($transaction->getId());
header('Location: ' . $payment->getCheckoutUrl());
```

### TAP Wallet (iFrame)

[](#tap-wallet-iframe)

```
$transaction = $pg->createTransaction([
    'mfs_connection_id' => 3,
    'amount'            => 200,
]);

$tapConfig = $pg->initiateTap($transaction->getId());
// Pass $tapConfig to your view — load TAP script + call tapIFrame()
```

Check Payment Status
--------------------

[](#check-payment-status)

```
$transaction = $pg->getTransaction('ORDER-123'); // by reference_id

if ($transaction->isSuccess()) {
    // Payment confirmed — fulfill order
    echo "Payment received: ৳" . $transaction->getAmount();
    echo "TXN ID: " . $transaction->getMfsTransactionId();
}

if ($transaction->isFailed()) {
    echo "Payment failed: " . $transaction->getFailureReason();
}
```

Handle IPN Webhook
------------------

[](#handle-ipn-webhook)

```
// Your IPN endpoint (POST https://yoursite.com/ipn)
$pg = new PayGuard('your-api-key');

try {
    $payload = $pg->parseWebhook(
        rawBody:       file_get_contents('php://input'),
        webhookSecret: 'your-webhook-secret', // from MFS connection settings
        signature:     $_SERVER['HTTP_X_PAYGUARD_SIGNATURE'] ?? ''
    );

    $referenceId = $payload['reference_id'];
    $status      = $payload['status'];
    $amount      = $payload['amount'];
    $event       = $payload['event']; // payment.success or payment.failed

    if ($event === 'payment.success') {
        // Mark order as paid in your system
        markOrderAsPaid($referenceId, $amount);
    }

    http_response_code(200);
    echo 'OK';

} catch (\PayGuard\Exceptions\PayGuardException $e) {
    http_response_code(400);
    echo 'Invalid webhook';
}
```

Laravel Integration
-------------------

[](#laravel-integration)

```
// config/services.php
'payguard' => [
    'api_key'  => env('PAYGUARD_API_KEY'),
    'base_url' => env('PAYGUARD_BASE_URL', 'https://app.sourcemonkey.online/api/v1'),
],

// AppServiceProvider.php
$this->app->singleton(\PayGuard\PayGuard::class, function () {
    return new \PayGuard\PayGuard(
        config('services.payguard.api_key'),
        config('services.payguard.base_url'),
    );
});

// In controller
use PayGuard\PayGuard;

class CheckoutController extends Controller
{
    public function __construct(private PayGuard $pg) {}

    public function pay(Request $request)
    {
        $transaction = $this->pg->createTransaction([
            'mfs_connection_id' => 1,
            'amount'            => $request->amount,
            'reference_id'      => $request->order_id,
            'callback_url'      => route('ipn'),
        ]);

        $payment = $this->pg->initiateBkash($transaction->getId());
        return redirect($payment->getCheckoutUrl());
    }

    public function ipn(Request $request)
    {
        $payload = $this->pg->parseWebhook(
            $request->getContent(),
            config('services.payguard.webhook_secret'),
            $request->header('X-PayGuard-Signature')
        );

        if ($payload['event'] === 'payment.success') {
            Order::where('id', $payload['reference_id'])->update(['status' => 'paid']);
        }

        return response('OK');
    }
}
```

Error Handling
--------------

[](#error-handling)

```
use PayGuard\Exceptions\PayGuardException;
use PayGuard\Exceptions\AuthenticationException;
use PayGuard\Exceptions\ValidationException;

try {
    $transaction = $pg->createTransaction([...]);
} catch (AuthenticationException $e) {
    // Invalid API key
    echo "Auth failed: " . $e->getMessage();
} catch (ValidationException $e) {
    // Invalid parameters
    echo "Validation errors: ";
    print_r($e->errors);
} catch (PayGuardException $e) {
    // Other errors
    echo "Error [{$e->errorCode}]: " . $e->getMessage();
}
```

Available Methods
-----------------

[](#available-methods)

MethodDescription`createTransaction(array)`Create payment transaction`getTransaction(string)`Get by reference ID`listTransactions(array)`List with filters`getTransactionSummary(array)`Stats summary`initiateBkash(int)`Start bKash payment`queryBkash(int)`Check bKash status`refundBkash(int, float)`Refund bKash`initiateNagad(int)`Start Nagad payment`queryNagad(int)`Check Nagad status`initiateTap(int)`Get TAP iFrame config`queryTap(int)`Check TAP status`getConnections()`List MFS connections`testConnection(int)`Test a connection`getSubscription()`Get subscription`getPlans()`Available plans`verifyWebhook(...)`Verify IPN signature`parseWebhook(...)`Parse + verify IPNGet API Key
-----------

[](#get-api-key)

Login to your merchant dashboard: `https://app.sourcemonkey.online/merchant/api`

Support
-------

[](#support)

- Email:
- Documentation:

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance90

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

46d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/757463?v=4)[Md. Sanaullah asif](/maintainers/abefimrs)[@abefimrs](https://github.com/abefimrs)

---

Top Contributors

[![abefimrs](https://avatars.githubusercontent.com/u/757463?v=4)](https://github.com/abefimrs "abefimrs (4 commits)")

---

Tags

paymentbkashtapnagadbangladeshpayguard

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/payguard-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/payguard-sdk/health.svg)](https://phpackages.com/packages/payguard-sdk)
```

###  Alternatives

[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.4k567.5M2.9k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.1k1.0M59](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3751.3M49](/packages/tencentcloud-tencentcloud-sdk-php)[chargebee/chargebee-php

ChargeBee API client implementation for PHP

758.9M10](/packages/chargebee-chargebee-php)[shetabit/multipay

PHP Payment Gateway Integration Package

299382.6k4](/packages/shetabit-multipay)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

353.6k](/packages/eslazarev-wildberries-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)