mmpay-python-sdk 0.1.0__tar.gz → 0.1.1__tar.gz

{mmpay_python_sdk-0.1.0 → mmpay_python_sdk-0.1.1}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: mmpay-python-sdk
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python SDK for MMPay (Ported from JS)
-Author: Your Name
+Author: MyanMyanPay
 Requires-Python: >=3.6
 Requires-Dist: requests
 Dynamic: author

{mmpay_python_sdk-0.1.0 → mmpay_python_sdk-0.1.1}/README.md

@@ -64,8 +64,8 @@ Passed to `sdk.pay(params)` or `sdk.sandbox_pay(params)`.
 | `orderId` | `str` | Yes | Unique identifier for the order (e.g., "ORD-001"). |
 | `amount` | `number` | Yes | Total transaction amount. |
 | `items` | `List[Item]` | Yes | A list of items included in the order (see table below). |
-| `currency` | `str` | No | Currency code (e.g., "MMK", "USD"). |
 | `callbackUrl` | `str` | No | URL where the webhook callback will be sent. |
+| `customMessage` | `str` | No | URL where the webhook callback will be sent. |
 
 ### 2. Item Object
 
@@ -83,9 +83,9 @@ try:
     payment_request = {
         "orderId": "ORD-SANDBOX-001",
         "amount": 5000,             # Amount in minor units (e.g., cents) or as required
-        "currency": "MMK",
-        "callbackUrl": "[https://your-site.com/webhook/mmpay](https://your-site.com/webhook/mmpay)",
-        "items": [
+        "callbackUrl": "https://your-site.com/webhook/mmpay", # Optional
+        "customMessage": "Your Custom Messages", # Optional
+        "items": [  # Optional
             {
                 "name": "Premium Subscription",
                 "amount": 5000,
@@ -109,9 +109,15 @@ For production environments, use the `pay` method.
 try:
     payment_request = {
         "orderId": "ORD-LIVE-98765",
-        "amount": 10000,
-        "items": [
-            {"name": "E-Commerce Item", "amount": 10000, "quantity": 1}
+        "amount": 5000,             # Amount in minor units (e.g., cents) or as required
+        "callbackUrl": "https://your-site.com/webhook/mmpay", # Optional
+        "customMessage": "Your Custom Messages", # Optional
+        "items": [  # Optional
+            {
+                "name": "Premium Subscription",
+                "amount": 5000,
+                "quantity": 1
+            }
         ]
     }
 
@@ -125,15 +131,34 @@ except Exception as e:
 
 ### 3. Verify Callback (Webhook)
 
-When MMPay sends a callback to your `callbackUrl`, you must verify the request signature to ensure it is genuine.
+When MMPay sends a callback to your `callbackUrl`, you must verify the request signature to ensure it is genuine. If not provide, it will fallback to default cb URL provided in your console
+
+**Handling callbacks**
+
+Incoming HTTP POST Parameters
+
+Header
 
-### Callback Verification (`verify_cb`)
+| Field Name | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **Content-Type** | `string` | Yes | 'application/json' |
+| **X-Mmpay-Signature** | `string` | Yes | '34834890vfgh9hnf94irfg_48932i4rt90349849' |
+| **X-Mmpay-Nonce** | `string` | Yes | '94843943949349' |
+
+Body
+
+| Field Name    | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **orderId**           | `string` | Yes | Unique identifier for the specific order. |
+| **amount**            | `number` | Yes | The transaction amount. |
+| **currency**          | `string` | Yes | The 3-letter currency code (e.g., MMK, USD). |
+| **vendor**            | `string` | Yes | Identifier for the vendor initiating the request. |
+| **method**            | `'QR', 'PIN', 'PWA', 'CARD'`  | Yes | Identifier for the method. |
+| **status**            | `'PENDING','SUCCESS','FAILED','REFUNDED'` | Yes | Current status of the transaction. |
+| **transactionRefId**  | `string` | Yes | The reference ID generated by the payment provider. |
+| **callbackUrl**       | `string` | No | Optional URL to receive webhooks or updates. |
+| **customMessage**     | `string` | No | User provided custom message |
 
-| Parameter | Type | Description |
-| :--- | :--- | :--- |
-| `payload` | `str` | The **raw** JSON string body of the incoming request. |
-| `nonce` | `str` | The value of the `X-Mmpay-Nonce` header. |
-| `expected_signature` | `str` | The value of the `X-Mmpay-Signature` header. |
 
 **Example using Flask:**
 
@@ -144,6 +169,7 @@ from flask import request
 def mmpay_webhook():
     # 1. Get the raw payload body as a string (Crucial for signature check)
     payload_str = request.data.decode('utf-8') 
+    payload = request.data
     
     # 2. Get headers
     nonce = request.headers.get('X-Mmpay-Nonce')
@@ -155,6 +181,7 @@ def mmpay_webhook():
         
         if is_valid:
             # Process the order (e.g., mark as paid in DB)
+            
             return "Verified", 200
         else:
             return "Invalid Signature", 400
@@ -164,6 +191,28 @@ def mmpay_webhook():
 ```
 
 
+### 4. Error Codes
+
+##### Api Key Layer Authentication [SERVER SDK]
+| Code | Description |
+| :--- | :--- |
+| **`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 Authentication [SERVER SDK]
+| Code | Description |
+| :--- | :--- |
+| **`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 |
+
+
 ## License
 
 MIT

{mmpay_python_sdk-0.1.0 → mmpay_python_sdk-0.1.1}/mmpay/client.py

@@ -3,21 +3,22 @@ import json
 import hmac
 import hashlib
 import requests
-from typing import List, Optional, TypedDict, Dict, Any
+from typing import List, Optional, TypedDict, Dict, Any, Union
 
-# --- Type Definitions to mirror your Interfaces ---
+# --- Type Definitions ---
 
 class Item(TypedDict):
     name: str
     amount: float
     quantity: int
 
-class PaymentRequest(TypedDict):
+class PaymentRequest(TypedDict, total=False):
     orderId: str
     amount: float
-    items: List[Item]
+    items: Optional[List[Item]]
     currency: Optional[str]
     callbackUrl: Optional[str]
+    customMessage: Optional[str]  # Added to match TS
 
 class XPaymentRequest(PaymentRequest, total=False):
     appId: str
@@ -27,6 +28,21 @@ class HandShakeRequest(TypedDict):
     orderId: str
     nonce: str
 
+class HandShakeResponse(TypedDict):
+    token: str
+
+class CallbackIncomingData(TypedDict):
+    orderId: str
+    amount: float
+    method: str
+    currency: str
+    vendor: str
+    status: str
+    condition: str
+    transactionRefId: str
+    callbackUrl: Optional[str]
+    customMessage: Optional[str]
+
 class SDKOptions(TypedDict):
     appId: str
     publishableKey: str
@@ -43,12 +59,14 @@ class MMPaySDK:
         self._app_id = options['appId']
         self._publishable_key = options['publishableKey']
         self._secret_key = options['secretKey']
+        # Remove trailing slash if present to prevent double slashes in endpoints
         self._api_base_url = options['apiBaseUrl'].rstrip('/')
         self._btoken: Optional[str] = None
 
     def _generate_signature(self, body_string: str, nonce: str) -> str:
         """
         Generates an HMAC SHA256 signature for request integrity.
+        Matches: CryptoJS.HmacSHA256(nonce + "." + bodyString, secret)
         """
         string_to_sign = f"{nonce}.{body_string}"
         return hmac.new(
@@ -70,11 +88,10 @@ class MMPaySDK:
 
     # --- Sandbox Methods ---
 
-    def sandbox_handshake(self, payload: HandShakeRequest) -> Dict[str, Any]:
+    def sandbox_handshake(self, payload: HandShakeRequest) -> Union[HandShakeResponse, Dict[str, Any]]:
         endpoint = f"{self._api_base_url}/payments/sandbox-handshake"
         nonce = self._get_nonce()
         
-        # Ensure payload is serialized exactly as the signature expects
         body_string = self._json_stringify(payload)
         signature = self._generate_signature(body_string, nonce)
 
@@ -93,31 +110,39 @@ class MMPaySDK:
                 self._btoken = data['token']
             return data
         except requests.exceptions.RequestException as e:
-            # In a real SDK, you might want to raise custom exceptions here
-            return {"error": str(e), "details": response.text if response else None}
+            return {"error": str(e), "details": getattr(e.response, 'text', '')}
 
     def sandbox_pay(self, params: PaymentRequest) -> Dict[str, Any]:
         endpoint = f"{self._api_base_url}/payments/sandbox-create"
         nonce = self._get_nonce()
 
         # Construct payload
-        xpayload: XPaymentRequest = {
+        # Note: We manually build the dict to ensure we don't include None/null 
+        # for optional fields, which would break the signature vs JS stringify.
+        xpayload: Dict[str, Any] = {
             "appId": self._app_id,
             "nonce": nonce,
             "amount": params['amount'],
             "orderId": params['orderId'],
-            "items": params['items'],
         }
-        if 'callbackUrl' in params:
+
+        if params.get('items'):
+            xpayload['items'] = params['items']
+        if params.get('callbackUrl'):
             xpayload['callbackUrl'] = params['callbackUrl']
-        if 'currency' in params:
-            xpayload['currency'] = params['currency']
+        if params.get('customMessage'):
+            xpayload['customMessage'] = params['customMessage']
 
         body_string = self._json_stringify(xpayload)
         signature = self._generate_signature(body_string, nonce)
 
-        # Perform handshake first (as per TS logic)
-        handshake_res = self.sandbox_handshake({'orderId': xpayload['orderId'], 'nonce': xpayload['nonce']})
+        # Perform handshake first (using the nonce from the payload logic as per TS)
+        handshake_payload: HandShakeRequest = {
+            'orderId': str(xpayload['orderId']), 
+            'nonce': str(xpayload['nonce'])
+        }
+        
+        handshake_res = self.sandbox_handshake(handshake_payload)
         if 'error' in handshake_res:
             return handshake_res
 
@@ -134,11 +159,11 @@ class MMPaySDK:
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
-            return {"error": str(e), "details": response.text if response else None}
+            return {"error": str(e), "details": getattr(e.response, 'text', '')}
 
     # --- Production Methods ---
 
-    def handshake(self, payload: HandShakeRequest) -> Dict[str, Any]:
+    def handshake(self, payload: HandShakeRequest) -> Union[HandShakeResponse, Dict[str, Any]]:
         endpoint = f"{self._api_base_url}/payments/handshake"
         nonce = self._get_nonce()
         
@@ -160,29 +185,36 @@ class MMPaySDK:
                 self._btoken = data['token']
             return data
         except requests.exceptions.RequestException as e:
-            return {"error": str(e), "details": response.text if response else None}
+            return {"error": str(e), "details": getattr(e.response, 'text', '')}
 
     def pay(self, params: PaymentRequest) -> Dict[str, Any]:
         endpoint = f"{self._api_base_url}/payments/create"
         nonce = self._get_nonce()
 
-        xpayload: XPaymentRequest = {
+        xpayload: Dict[str, Any] = {
             "appId": self._app_id,
             "nonce": nonce,
             "amount": params['amount'],
             "orderId": params['orderId'],
-            "items": params['items'],
         }
-        if 'callbackUrl' in params:
+
+        if params.get('items'):
+            xpayload['items'] = params['items']
+        if params.get('callbackUrl'):
             xpayload['callbackUrl'] = params['callbackUrl']
-        if 'currency' in params:
-            xpayload['currency'] = params['currency']
+        if params.get('customMessage'):
+            xpayload['customMessage'] = params['customMessage']
 
         body_string = self._json_stringify(xpayload)
         signature = self._generate_signature(body_string, nonce)
 
         # Perform handshake
-        handshake_res = self.handshake({'orderId': xpayload['orderId'], 'nonce': xpayload['nonce']})
+        handshake_payload: HandShakeRequest = {
+            'orderId': str(xpayload['orderId']), 
+            'nonce': str(xpayload['nonce'])
+        }
+        
+        handshake_res = self.handshake(handshake_payload)
         if 'error' in handshake_res:
             return handshake_res
 
@@ -199,7 +231,7 @@ class MMPaySDK:
             response.raise_for_status()
             return response.json()
         except requests.exceptions.RequestException as e:
-            return {"error": str(e), "details": response.text if response else None}
+            return {"error": str(e), "details": getattr(e.response, 'text', '')}
 
     # --- Verification ---
 
@@ -218,6 +250,7 @@ class MMPaySDK:
         ).hexdigest()
 
         if generated_signature != expected_signature:
+            # Using print for logging as per TS console.error
             print(f"Signature mismatch: gen={generated_signature}, exp={expected_signature}")
             return False
         

{mmpay_python_sdk-0.1.0 → mmpay_python_sdk-0.1.1}/mmpay_python_sdk.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: mmpay-python-sdk
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python SDK for MMPay (Ported from JS)
-Author: Your Name
+Author: MyanMyanPay
 Requires-Python: >=3.6
 Requires-Dist: requests
 Dynamic: author

{mmpay_python_sdk-0.1.0 → mmpay_python_sdk-0.1.1}/setup.py

@@ -2,9 +2,9 @@ from setuptools import setup, find_packages
 
 setup(
     name="mmpay-python-sdk",
-    version="0.1.0",
+    version="0.1.1",
     description="Python SDK for MMPay (Ported from JS)",
-    author="Your Name",
+    author="MyanMyanPay",
     packages=find_packages(),
     install_requires=[
         "requests",

mmpay_python_sdk-0.1.1/test/test_sdk.py

@@ -0,0 +1,76 @@
+import time
+import os
+import random
+import string
+from dotenv import load_dotenv
+
+from mmpay import MMPaySDK
+# from mmpay_sdk import MMPaySDK  # Assumes the SDK is saved in mmpay_sdk.py
+
+# Load environment variables from .env file
+load_dotenv()
+
+def generate_secure_random_string(length: int) -> str:
+    """
+    Generates a random alphanumeric string.
+    """
+    # Using random.choices to generate a string of requested length
+    # This mimics the base36 behavior of the JS example
+    chars = string.ascii_lowercase + string.digits
+    return ''.join(random.choices(chars, k=length))
+
+def start():
+    """
+    Executes the payment call and measures network latency.
+    """
+    # Initialize SDK
+    # specific env keys matching your JS example
+    mmpay = MMPaySDK({
+        'appId': os.getenv('APP_ID', ''),
+        'publishableKey': os.getenv('PUB_KEY', ''),
+        'secretKey': os.getenv('SEC_KEY', ''),
+        'apiBaseUrl': os.getenv('BASEURL', '')
+    })
+
+    # Generate Order ID
+    order_id = generate_secure_random_string(6)
+
+    # Start Timer
+    # time.perf_counter() is the Python equivalent to performance.now()
+    start_time = time.perf_counter()
+
+    try:
+        payload = {
+            "orderId": order_id,
+            "amount": 1500,
+            "customMessage": "MyanMyanPay Is The Best",
+            "items": [{"name": "Items", "amount": 3000, "quantity": 1}]
+        }
+
+        # Execute Payment (Synchronous in Python version)
+        response = mmpay.sandbox_pay(payload)
+
+        # End Timer
+        end_time = time.perf_counter()
+        
+        # Calculate latency in milliseconds
+        latency_ms = (end_time - start_time) * 1000
+
+        print(f"\n--- Transaction Request Successful ---")
+        print(f"Order ID: {order_id}")
+        print(f"**Network Latency: {latency_ms:.3f} ms**")
+        print(f"Response: {response}")
+        print(f"------------------------------\n")
+
+    except Exception as error:
+        end_time = time.perf_counter()
+        latency_ms = (end_time - start_time) * 1000
+
+        print(f"\n--- Transaction Request Failed ---")
+        print(f"Order ID: {order_id}")
+        print(f"**Network Latency: {latency_ms:.3f} ms**")
+        print(f"Error Message: {str(error)}")
+        print(f"--------------------------\n")
+
+if __name__ == "__main__":
+    start()

mmpay_python_sdk-0.1.0/test/test_sdk.py

@@ -1,21 +0,0 @@
-from mmpay import MMPaySDK
-
-# Initialize
-sdk = MMPaySDK({
-    "appId": "your_app_id",
-    "publishableKey": "your_pub_key",
-    "secretKey": "your_secret_key",
-    "apiBaseUrl": "https://api.mmpay.com" # Example URL
-})
-
-# Create a Payment (Sandbox)
-response = sdk.sandbox_pay({
-    "orderId": "ORD-123456789",
-    "amount": 1000,
-    "callbackUrl": "https://yoursite.com/callback",
-    "items": [
-        {"name": "Test Item", "amount": 1000, "quantity": 1}
-    ]
-})
-
-print(response)