PHPackages                             myanmyanpay/mmpay-php-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. myanmyanpay/mmpay-php-sdk

ActiveLibrary[Payment Processing](/categories/payments)

myanmyanpay/mmpay-php-sdk
=========================

PHP One Time MMQR generation and Payment integration software developement kit created by MyanMyanPay Team

1.0.4(3w ago)0279MITPHPPHP >=7.4

Since Jan 23Pushed 3w agoCompare

[ Source](https://github.com/nawing/MMPay-Php-SDK)[ Packagist](https://packagist.org/packages/myanmyanpay/mmpay-php-sdk)[ RSS](/packages/myanmyanpay-mmpay-php-sdk/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (4)Versions (4)Used By (0)

MMPay PHP SDK
=============

[](#mmpay-php-sdk)

A professional, comprehensive PHP client library for integrating with the MMPay Payment Gateway. This SDK mimics the official Node.js SDK structure, providing robust utilities for payment creation, handshake authentication, and secure webhook verification.

📦 1. Installation
-----------------

[](#-1-installation)

Requires PHP 7.4 or higher.

Install the package via Composer:

```
composer require myanmyanpay/mmpay-php-sdk
```

---

🚀 2. Configuration
------------------

[](#-2-configuration)

To start, initialize the SDK with your Merchant credentials found in the MMPay Dashboard.

**Implementation**

```
use MMPay\MMPay;

$options = [
    'appId'          => 'YOUR_APP_ID',
    'publishableKey' => 'YOUR_PUBLISHABLE_KEY',
    'secretKey'      => 'YOUR_SECRET_KEY',
    'apiBaseUrl'     => '[https://api.mmpay.com](https://api.mmpay.com)'
];

$mmpayx = new MMPay($options);
```

**Configuration Parameters**

ParameterTypeRequiredDescription`appId``string`**Yes**Your unique Application ID.`publishableKey``string`**Yes**Public key used for identification.`secretKey``string`**Yes**Private key used for HMAC SHA256 signing.`apiBaseUrl``string`**Yes**The base URL for the MMPay API.---

🛠 3. Create a Payment
---------------------

[](#-3-create-a-payment)

`pay` This method automatically handles the required handshake and signature generation.

**Method Signature**

```
$mmpayx->pay($payload);
```

**Implementation**

```
try {
    $payload = [
        'orderId'       => 'ORD-SANDBOX-001',
        'amount'        => 5000,
        'currency'      => 'MMK',
        'callbackUrl'   => '[https://yoursite.com/webhook/mmpay](https://yoursite.com/webhook/mmpay)',
        'customMessage' => 'Thank you for shopping with us!', // Optional
        'items'         => [
            [
                'name'     => 'Premium Subscription',
                'amount'   => 5000,
                'quantity' => 1
            ]
        ]
    ];

    $response = $mmpayx->pay($payload);
    print_r($response);

} catch (Exception $e) {
    echo "Payment Failed: " . $e->getMessage();
}
```

**Request Body** (`payload` structure)

FieldTypeRequiredDescriptionExample**`orderId`**`string`**Yes**Your generated order ID for the order or system initiating the payment.`"ORD-3983833"`**`amount`**`number`**Yes**The total transaction amount.`1500.50`**`callbackUrl`**`string`NoThe URL where the payment gateway will send transaction status updates.`"https://yourserver.com/webhook"`**`currency`**`string`NoThe currency code (e.g., `'MMK'`).`"MMK"`**`customMessage`**`string`NoYour Customization String**`items`**`Array`NoList of items included in the purchase.`[{name: "Hat", amount: 1000, quantity: 1}]`**Item Object**

FieldTypeDescription**`name`**`string`The name of the item.**`amount`**`number`The unit price of the item.**`quantity`**`number`The number of units purchased.**Response Body** Code (`201`)

```
{
  "orderId": "_trx_0012345",
  "status": "PENDING",
  "vendorQrRefId": "39233043003345",
  "transactionRefId": "39233043003345", // This is deprecated - transactionRefId will show only after payment is confirmed
  "amount": 2800,
  "currency": "MMK",
  "qr": "EMVco MMQR String => You_have_to_embed_as_qr_image_yourself"
}
```

---

🛠 4. Retrieve Payment
---------------------

[](#-4-retrieve-payment)

This method is used to retrieve a payment and MMQR related events.

**Method Signature**

```
$mmpayx->get($payload);
```

**Implementation**

```
try {
    $payload = [
        'orderId'     => 'ORD-LIVE-888'
    ];
    $response = $mmpayx->get($payload);
    if (isset($response['url'])) {
        header('Location: ' . $response['url']);
        exit;
    }
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

**Request Body** (`payload` structure)

FieldTypeRequiredDescriptionExample**`orderId`**`string`**Yes**Your generated order ID for the order or system initiating the payment.`"ORD-3983833"`**Response Body** Code (`200`)

```
{
  "orderId": "ORD-111111111",
  "appId": "MMP3883483",
  "amount": 1000,
  "vendor": "KBZPay",
  "method": "QR",
  "customMessage": "",
  "callbackUrl": "",
  "callbackUrlAt": "JSDateObject",
  "callbackUrlStatus": "SUCCESS",
  "status": "SUCCESS", //  'PENDING' | 'SUCCESS' | 'FAILED' | 'REFUNDED' | 'CANCELLED' | 'EXPIRED';
  "disbursementId": "289348734939",
  "disStatus": "SUCCESS",
  "condition": "TOUCHED", // TOUCHED | 'PRISTINE' | 'DIRTY' | 'EXPIRED'
  "createdAt": "JSDateObject",
  "transactionRefId": "939583046594",
  "vendorQrRefId": "48309449034",
  "qr": "EMVCo QR String::MMQR Standard",
}
```

---

🛠 5. Cancel Payment
-------------------

[](#-5-cancel-payment)

This method is used to cancel a payment and all of its MMQR releated instances

**Method Signature**

```
$mmpayx->cancel($payload);
```

**Implementation**

```
try {
    $payload = [
        'orderId'     => 'ORD-LIVE-888'
    ];
    $response = $mmpayx->cancel($payload);
    if (isset($response['url'])) {
        header('Location: ' . $response['url']);
        exit;
    }
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}
```

**Request Body** (`payload` structure)

FieldTypeRequiredDescriptionExample**`orderId`**`string`**Yes**Your generated order ID for the order or system initiating the payment.`"ORD-3983833"`**Response Body** Code (`200`)

```
{
  "amount": 1000,
  "orderId": "ORD-111111111",
  "status": "CANCELLED",
  "vendorQrRefId": "289348734939",
}
```

---

🔐 6. Handling Webhooks
----------------------

[](#-6-handling-webhooks)

To secure your webhook endpoint that receives callbacks from the MMPay server, use this event listener to handle the events. The **listen** performs the mandatory Signature and Nonce verification and emits events

**Handling callbacks**

Incoming HTTP POST Parameters

Header

Field NameTypeRequiredDescription**Content-Type**`string`Yes'application/json'**X-Mmpay-Signature**`string`Yes'34834890vfgh9hnf94irfg\_48932i4rt90349849'**X-Mmpay-Nonce**`string`Yes'94843943949349'Body

Field NameTypeRequiredDescription**orderId**`string`YesUnique identifier for the specific order.**amount**`number`YesThe transaction amount.**currency**`string`YesThe 3-letter currency code (e.g., MMK, USD).**vendor**`string`YesIdentifier for the vendor initiating the request.**method**`'QR', 'PIN', 'PWA', 'CARD'`YesIdentifier for the method.**status**`'PENDING','SUCCESS','FAILED','REFUNDED', 'EXPIRED', 'CANCELLED'`YesCurrent status of the transaction.**condition**`'PRESTINE', 'TOUCHED', 'EXPIRED', 'DIRTY'`YesUsed QR Code scan again or not**transactionRefId**`string`YesThe reference ID generated by the payment provider after success payment**vendorQrRefId**`string`YesThe MMQR reference ID generated by the payment provider.**callbackUrl**`string`NoOptional URL to receive webhooks or updates.**customMessage**`string`NoUser provided custom message**Example Implementation With Laravel**

In Laravel, you should use the `Request` object to fetch headers and the raw content.

```
namespace App\Http\Controllers;

use Illuminate\Http\Request;
use MMPay\MMPay;

class PaymentWebhookController extends Controller
{
    public function handle(Request $request)
    {
        $mmpayx = new MMPay([
            'appId' => config('services.mmpay.app_id'),
            'publishableKey' => config('services.mmpay.publish_key'),
            'secretKey' => config('services.mmpay.secret_key'),
            'apiBaseUrl' => 'https://api.myanmyanpay.com'
        ]);

        $mmpayx->onTxCreate(function ($tx) {
            \Log::info("Payment Created for order: " . $tx['orderId']);
            // Verify Source of truth here if you are using browser mmpayx showPaymentModal()
        });

        // Attach listeners
        $mmpayx->onTxSuccess(function ($tx) {
            // Update your database order status here
            \Log::info("Payment Successful for order: " . $tx['orderId']);
        });

        $mmpayx->onTxFail(function ($tx) {
            \Log::error("Payment Failed for order: " . $tx['orderId']);
        });

        $mmpayx->onTxCancel(function ($tx) {
            \Log::info("Payment Cancelled for order: " . $tx['orderId']);
        });

        $mmpayx->onTxExpire(function ($tx) {
            \Log::info("Payment Expired for order: " . $tx['orderId']);
        });

        $mmpayx->onHeartbeat(function ($tx) {
            \Log::info("Already Sent Event Coming in Again: " . $tx['orderId']);
        });

        // Get headers and raw body
        $nonce = $request->header('X-Mmpay-Nonce');
        $signature = $request->header('X-Mmpay-Signature');
        $payload = $request->getContent();

        // Listen triggers the events
        $mmpayx->listen($payload, $nonce, $signature);

        return response()->json(['received' => true], 200);
    }
}
```

---

⚠️ 7. Error Handling
--------------------

[](#️-7-error-handling)

The mmpayx throws standard PHP `\Exception` when errors occur (e.g., network issues, API validation errors, or handshake failures).

```
try {
    $sdk->pay($params);
} catch (\Exception $e) {
    // Log the error for debugging
    error_log($e->getMessage());

    // Return a user-friendly message
    echo "We could not process your payment at this time.";
}
```

---

⚠️ 8. Error Codes
-----------------

[](#️-8-error-codes)

**HMac Layer (SERVER Side)**

CodeDescription**`KA0001`**Bearer Token Not Included In Your Request**`KA0002`**API Key Not 'LIVE'**`KA0003`**Signature mismatch**`KA0004`**Internal Server Error ( Talk to our support immediately fot this )**`KA0005`**IP Not whitelisted**`429`**Ratelimit hit only 1000 request / minute allowed**JWT Layer (SERVER Side)**

CodeDescription**`BA001`**`Btoken` is nonce one time token is not included**`BA002`**`Btoken` one time nonce mismatch**`BA000`**Internal Server Error ( Talk to our support immediately fot this )**`429`**Ratelimit hit only 1000 request / minute allowed**Response Codes**

CodeStatusDescription**`201`**CreatedTransaction initiated successfully. Response contains QR code URL/details.**`401`**UnauthorizedInvalid or missing Publishable Key.**`400`**Bad RequestMissing required body fields (validated by schema, if implemented).**`503`**Service UnavailableUpstream payment API failed or is unreachable.**`500`**Internal Server ErrorGeneral server error during payment initiation.---

📄 License
---------

[](#-license)

MIT License.

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance85

Actively maintained with recent releases

Popularity15

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

 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 ~69 days

Total

3

Last Release

22d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/23611465?v=4)[Naw Ing](/maintainers/nawing)[@nawing](https://github.com/nawing)

---

Top Contributors

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

### Embed Badge

![Health badge](/badges/myanmyanpay-mmpay-php-sdk/health.svg)

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

###  Alternatives

[laravel/framework

The Laravel Framework.

34.8k543.8M20.1k](/packages/laravel-framework)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[saithink/saiadmin

webman plugin

28211.5k1](/packages/saithink-saiadmin)[lion/bundle

Lion-framework configuration and initialization package

122.3k4](/packages/lion-bundle)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

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

PHPackages © 2026

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