@wikha/sdk 1.1.13 → 1.1.15

package/README.md

@@ -18,6 +18,12 @@ console.log(WikhaSDK.Environment.sandbox);
 
 
 # Processing a Payment
+
+## Security & Payload Encryption
+By default, when using this SDK in a browser environment, it will send the data in **plaintext** (`{ data: ... }`) if the `crypto` module is not present. However, if you are using Node.js (or if a Polyfill is provided), the SDK will automatically compress and encrypt your payload in RSA using the `encryptedData` field.
+
+The Wikha API accepts both formats but we strongly encourage RSA encryption for production usage.
+
 ## Use the processPayment method to initiate a payment. 
 You'll need to provide a WikhaPayload object with the necessary payment details.
 
@@ -39,10 +45,20 @@ async function initiatePayment() {
     payer_name: 'John Tshisola',
     operation: WikhaSDK.PaymentType.payin,
     currency: 'CDF',
-    notify_url: '[https://your-callback-url.com/notify](https://www.google.com/search?q=https://your-callback-url.com/notify)',
-    return_url: '[https://your-website.com/success](https://www.google.com/search?q=https://your-website.com/success)',
+    notify_url: '[https://your-callback-url.com/notify](https://your-callback-url.com/notify)',
+    return_url: '[https://your-website.com/success](https://your-website.com/success)',
   };
 
+  /**
+   * Note on Notifications (Webhooks):
+   * 1. The API supports `notify_url` or `notifyUrl`.
+   * 2. If provided in the payload, this URL will be used for webhooks.
+   * 3. NEW: If NOT provided, the API will fall back to the merchant's default notify_url 
+   *    configured in the Wikha Dashboard.
+   * 4. The webhook includes an 'X-Wikha-Signature' header (HMAC-SHA256) signed 
+   *    with your API Key.
+   */
+
   try {
     const response = await sdk.processPayment(paymentData);
     console.log('Payment initiated successfully:', response);
@@ -55,6 +71,36 @@ async function initiatePayment() {
 
 initiatePayment();
 ```
+
+## Processing a Payout (Withdrawal)
+
+```TypeScript
+import { WikhaSDK } from '@wikha/sdk';
+
+const sdk = new WikhaSDK('YOUR_API_KEY', 'YOUR_MERCHANT_ID');
+
+async function initiatePayout() {
+  const payoutData: WikhaSDK.WikhaPayload = {
+    provider: WikhaSDK.PaymentProviderType.mpesa,
+    payer_phone: '081XXXXXXX',
+    order_id: 'WITHDRAW-789',
+    amount: 50,
+    payer_name: 'Jane Doe',
+    operation: WikhaSDK.PaymentType.payout, // Mandatory for withdrawals
+    currency: 'USD',
+    notify_url: 'https://your-callback-url.com/payout-notify', // Highly recommended for async updates
+  };
+
+  try {
+    const response = await sdk.processPayment(payoutData);
+    console.log('Payout initiated:', response);
+  } catch (error: any) {
+    console.error('Payout failed:', error.message);
+  }
+}
+
+initiatePayout();
+```
 # Query transaction status
 
 ```typescript

package/dist/src/sdk.d.ts

@@ -1,4 +1,4 @@
-export declare const PAY_ENDPOINT = "https://api.wikha-hitech.com/v2";
+export declare const PAY_ENDPOINT = "https://api.wikha-hitech.com/v2/payments";
 export declare const TRANSACTION_QUERY_ENDPOINT = "https://api.wikha-hitech.com/v2/query";
 export declare enum PaymentProviderType {
     mpesa = "mpesa",

package/dist/src/sdk.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WikhaSDK = exports.Environment = exports.MerchantStatus = exports.PaymentAggregatorType = exports.PaymentStatus = exports.PaymentType = exports.PaymentProviderType = exports.TRANSACTION_QUERY_ENDPOINT = exports.PAY_ENDPOINT = void 0;
 // Constants
-exports.PAY_ENDPOINT = "https://api.wikha-hitech.com/v2";
+exports.PAY_ENDPOINT = "https://api.wikha-hitech.com/v2/payments";
 exports.TRANSACTION_QUERY_ENDPOINT = "https://api.wikha-hitech.com/v2/query";
 const isNode = typeof window === 'undefined' && typeof process !== 'undefined';
 // Interfaces & Enums
@@ -59,7 +59,9 @@ class WikhaSDK {
         }
         if (isNode) {
             try {
-                return require('node-fetch');
+                // Use eval('require') to evade webpack/esbuild statically evaluating node-fetch for browsers
+                const req = eval('require');
+                return req('node-fetch');
             }
             catch (e) {
                 console.warn("Native fetch not found and 'node-fetch' not installed.");
@@ -95,7 +97,8 @@ class WikhaSDK {
         }
         const dataString = JSON.stringify({ ...data, merchant_id: this.merchantId });
         if (isNode) {
-            const crypto = require('crypto');
+            const req = eval('require');
+            const crypto = req('crypto');
             try {
                 const encrypted = crypto.publicEncrypt({
                     key: this.publicKey,