payx-node 1.0.0

package/README.md

@@ -0,0 +1,59 @@
+# PayX Node.js SDK
+
+The official Node.js SDK for the PayX Payment Gateway.
+
+## Installation
+
+```bash
+npm install payx-node
+# or
+yarn add payx-node
+```
+
+## Usage
+
+### Initialize the Client
+
+```javascript
+const { PayX } = require('payx-node');
+
+const payx = new PayX({
+  apiKey: 'your_payx_api_key'
+});
+```
+
+### Initiate a Mobile Money Charge
+
+```javascript
+async function chargeCustomer() {
+  try {
+    const response = await payx.charge.create({
+      amount: 10.0,
+      currency: 'GHS',
+      phoneNumber: '0551234987',
+      network: 'MTN',
+      payerMessage: 'Order #1234',
+      payeeNote: 'SaaS Subscription'
+    });
+    
+    console.log('Transaction ID:', response.transactionId);
+    console.log('Status:', response.status);
+  } catch (error) {
+    console.error('Charge failed:', error.message);
+  }
+}
+```
+
+### Verify Webhook Signatures
+
+```javascript
+const isValid = payx.webhooks.verifySignature(
+  req.rawBody, 
+  req.headers['x-payx-signature'], 
+  'your_webhook_secret'
+);
+```
+
+## Documentation
+
+For full documentation, visit [docs.payx.app](https://docs.payx.app).

package/dist/index.d.mts

@@ -0,0 +1,91 @@
+import { AxiosInstance } from 'axios';
+
+interface PayXConfig {
+    /**
+     * Your PayX API Key (Test or Live)
+     */
+    apiKey: string;
+    /**
+     * Optional base URL for the API (defaults to https://api.payx.app/v1)
+     */
+    baseURL?: string;
+}
+type Network = 'MTN' | 'TELECEL' | 'AIRTELTIGO';
+interface ChargeParams {
+    amount: number | string;
+    phoneNumber: string;
+    network: Network;
+    currency?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+}
+interface PayoutParams {
+    amount: number | string;
+    phoneNumber: string;
+    network: Network;
+    currency?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+}
+interface TransactionResponse {
+    message: string;
+    transactionId: string;
+    status: 'PENDING' | 'SUCCESSFUL' | 'FAILED';
+    mode?: 'test' | 'live';
+}
+interface WebhookEvent {
+    event: string;
+    data: {
+        id: string;
+        amount: number;
+        currency: string;
+        status: string;
+        reference: string;
+        customer: {
+            phone: string;
+            network: string;
+        };
+    };
+}
+
+declare class ChargeResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Initiate a Mobile Money Collection
+     * @param params Charge parameters
+     * @returns Transaction status
+     */
+    create(params: ChargeParams): Promise<TransactionResponse>;
+}
+
+declare class PayoutResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Initiate a Mobile Money Disbursement
+     * @param params Payout parameters
+     * @returns Transaction status
+     */
+    create(params: PayoutParams): Promise<TransactionResponse>;
+}
+
+declare class WebhookResource {
+    /**
+     * Verify the signature of a PayX webhook request
+     * @param payload The raw body of the request
+     * @param signature The x-payx-signature header
+     * @param secret Your PayX Webhook Secret (found in Developer Dashboard)
+     */
+    verifySignature(payload: string, signature: string, secret: string): boolean;
+}
+
+declare class PayX {
+    private client;
+    charge: ChargeResource;
+    payout: PayoutResource;
+    webhooks: WebhookResource;
+    constructor(config: PayXConfig);
+}
+
+export { type ChargeParams, type Network, PayX, type PayXConfig, type PayoutParams, type TransactionResponse, type WebhookEvent };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import { AxiosInstance } from 'axios';
+
+interface PayXConfig {
+    /**
+     * Your PayX API Key (Test or Live)
+     */
+    apiKey: string;
+    /**
+     * Optional base URL for the API (defaults to https://api.payx.app/v1)
+     */
+    baseURL?: string;
+}
+type Network = 'MTN' | 'TELECEL' | 'AIRTELTIGO';
+interface ChargeParams {
+    amount: number | string;
+    phoneNumber: string;
+    network: Network;
+    currency?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+}
+interface PayoutParams {
+    amount: number | string;
+    phoneNumber: string;
+    network: Network;
+    currency?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+}
+interface TransactionResponse {
+    message: string;
+    transactionId: string;
+    status: 'PENDING' | 'SUCCESSFUL' | 'FAILED';
+    mode?: 'test' | 'live';
+}
+interface WebhookEvent {
+    event: string;
+    data: {
+        id: string;
+        amount: number;
+        currency: string;
+        status: string;
+        reference: string;
+        customer: {
+            phone: string;
+            network: string;
+        };
+    };
+}
+
+declare class ChargeResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Initiate a Mobile Money Collection
+     * @param params Charge parameters
+     * @returns Transaction status
+     */
+    create(params: ChargeParams): Promise<TransactionResponse>;
+}
+
+declare class PayoutResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Initiate a Mobile Money Disbursement
+     * @param params Payout parameters
+     * @returns Transaction status
+     */
+    create(params: PayoutParams): Promise<TransactionResponse>;
+}
+
+declare class WebhookResource {
+    /**
+     * Verify the signature of a PayX webhook request
+     * @param payload The raw body of the request
+     * @param signature The x-payx-signature header
+     * @param secret Your PayX Webhook Secret (found in Developer Dashboard)
+     */
+    verifySignature(payload: string, signature: string, secret: string): boolean;
+}
+
+declare class PayX {
+    private client;
+    charge: ChargeResource;
+    payout: PayoutResource;
+    webhooks: WebhookResource;
+    constructor(config: PayXConfig);
+}
+
+export { type ChargeParams, type Network, PayX, type PayXConfig, type PayoutParams, type TransactionResponse, type WebhookEvent };

package/dist/index.js

@@ -0,0 +1,131 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PayX: () => PayX
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var import_axios3 = __toESM(require("axios"));
+
+// src/resources/charge.ts
+var import_axios = __toESM(require("axios"));
+var ChargeResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Initiate a Mobile Money Collection
+   * @param params Charge parameters
+   * @returns Transaction status
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/charge", params);
+      return response.data;
+    } catch (error) {
+      if (import_axios.default.isAxiosError(error) && error.response) {
+        throw new Error(`PayX Charge Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/resources/payout.ts
+var import_axios2 = __toESM(require("axios"));
+var PayoutResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Initiate a Mobile Money Disbursement
+   * @param params Payout parameters
+   * @returns Transaction status
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/payout", params);
+      return response.data;
+    } catch (error) {
+      if (import_axios2.default.isAxiosError(error) && error.response) {
+        throw new Error(`PayX Payout Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/resources/webhooks.ts
+var import_crypto = __toESM(require("crypto"));
+var WebhookResource = class {
+  /**
+   * Verify the signature of a PayX webhook request
+   * @param payload The raw body of the request
+   * @param signature The x-payx-signature header
+   * @param secret Your PayX Webhook Secret (found in Developer Dashboard)
+   */
+  verifySignature(payload, signature, secret) {
+    if (!payload || !signature || !secret) return false;
+    const hash = import_crypto.default.createHmac("sha256", secret).update(payload).digest("hex");
+    return hash === signature;
+  }
+};
+
+// src/client.ts
+var PayX = class {
+  client;
+  charge;
+  payout;
+  webhooks;
+  constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("PayX API Key is required");
+    }
+    this.client = import_axios3.default.create({
+      baseURL: config.baseURL || "https://api.payx.app/v1",
+      headers: {
+        "x-api-key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+    this.charge = new ChargeResource(this.client);
+    this.payout = new PayoutResource(this.client);
+    this.webhooks = new WebhookResource();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PayX
+});

package/dist/index.mjs

@@ -0,0 +1,94 @@
+// src/client.ts
+import axios3 from "axios";
+
+// src/resources/charge.ts
+import axios from "axios";
+var ChargeResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Initiate a Mobile Money Collection
+   * @param params Charge parameters
+   * @returns Transaction status
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/charge", params);
+      return response.data;
+    } catch (error) {
+      if (axios.isAxiosError(error) && error.response) {
+        throw new Error(`PayX Charge Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/resources/payout.ts
+import axios2 from "axios";
+var PayoutResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Initiate a Mobile Money Disbursement
+   * @param params Payout parameters
+   * @returns Transaction status
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/payout", params);
+      return response.data;
+    } catch (error) {
+      if (axios2.isAxiosError(error) && error.response) {
+        throw new Error(`PayX Payout Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/resources/webhooks.ts
+import crypto from "crypto";
+var WebhookResource = class {
+  /**
+   * Verify the signature of a PayX webhook request
+   * @param payload The raw body of the request
+   * @param signature The x-payx-signature header
+   * @param secret Your PayX Webhook Secret (found in Developer Dashboard)
+   */
+  verifySignature(payload, signature, secret) {
+    if (!payload || !signature || !secret) return false;
+    const hash = crypto.createHmac("sha256", secret).update(payload).digest("hex");
+    return hash === signature;
+  }
+};
+
+// src/client.ts
+var PayX = class {
+  client;
+  charge;
+  payout;
+  webhooks;
+  constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("PayX API Key is required");
+    }
+    this.client = axios3.create({
+      baseURL: config.baseURL || "https://api.payx.app/v1",
+      headers: {
+        "x-api-key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+    this.charge = new ChargeResource(this.client);
+    this.payout = new PayoutResource(this.client);
+    this.webhooks = new WebhookResource();
+  }
+};
+export {
+  PayX
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "payx-node",
+  "version": "1.0.0",
+  "description": "The official Node.js SDK for PayX",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "payx",
+    "payments",
+    "ghana",
+    "mobile-money"
+  ],
+  "author": "PayX",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/payx-app/payx-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/payx-app/payx-node/issues"
+  },
+  "homepage": "https://github.com/payx-app/payx-node#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.41",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  }
+}