@maxkabechani/mtn-momo-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Max Kabechani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,187 @@
+# MTN MoMo Node SDK (@maxkabechani/mtn-momo-sdk)
+
+TypeScript-first MTN Mobile Money client for Node.js. Fully compatible with official MoMo API v1.0 and v2.0.
+
+This SDK provides a type-safe, developer-friendly interface for integrating MTN Mobile Money into your applications. It supports **Collections**, **Disbursements**, and **Remittance** products.
+
+---
+
+## Features
+
+- **Coexistence of V1 & V2**: Use stable V1 endpoints by default or opt-in to latest V2 features (e.g., `depositV2`).
+- **Comprehensive Coverage**: Supporting everything from simple transfers to biometric consent (BC Authorize).
+- **TypeScript First**: Full type definitions for all requests and responses.
+- **Bun & Node.js**: Optimized for modern runtimes.
+
+---
+
+## Installation
+
+```bash
+npm install @maxkabechani/mtn-momo-sdk
+# or
+bun add @maxkabechani/mtn-momo-sdk
+```
+
+---
+
+## Quick Start (Sandbox)
+
+### 1. Initialize the Client
+```ts
+import { create, Environment } from "@maxkabechani/mtn-momo-sdk";
+
+const momo = create({
+  callbackHost: "yourdomain.com", // Used for callback validation
+  environment: Environment.SANDBOX,
+});
+```
+
+### 2. Configure a Product
+Each product (Collections, Disbursements, Remittance) is initialized separately:
+
+```ts
+const collections = momo.Collections({
+  primaryKey: "your_collections_primary_key",
+  userId: "your_user_id",
+  userSecret: "your_user_secret",
+});
+```
+
+### 3. Generate Sandbox Credentials
+If you don't have a `userId` and `userSecret` yet, you can generate them using our CLI tool:
+
+```bash
+npx momo-sandbox --host yourdomain.com --primary-key YOUR_PRIMARY_KEY
+```
+
+---
+
+## API Reference
+
+### Collections
+Manage incoming payments and withdrawals.
+
+#### `requestToPay(request: PaymentRequest)`
+Requests a payment from a consumer.
+- **Arguments**:
+  - `amount`: `string` (e.g., "100.00")
+  - `currency`: `string` (e.g., "EUR")
+  - `externalId`: `string` (Optional, for reconciliation)
+  - `payer`: `{ partyIdType: 'MSISDN' | 'EMAIL' | 'PARTY_CODE', partyId: string }`
+  - `payerMessage`: `string` (Optional, shown in payer history)
+  - `payeeNote`: `string` (Optional, shown in your history)
+  - `callbackUrl`: `string` (Optional, overrides global callback host)
+
+#### `getTransaction(referenceId: string)`
+Retrieves status of a payment request. Returns a `Payment` object with `status` (`PENDING`, `SUCCESSFUL`, `FAILED`).
+
+#### `getBalance()`
+Returns `{ availableBalance: string, currency: string }`.
+
+#### `requestToWithdrawV2(request: WithdrawalRequest)`
+Initiates a withdrawal from a payer account using V2 specs.
+
+---
+
+### Disbursements
+Manage payouts, deposits, and refunds.
+
+#### `transfer(request: TransferRequest)`
+Transfers money from your account to a payee.
+- **Arguments**:
+  - `amount`, `currency`, `externalId`: Same as Collections.
+  - `payee`: `{ partyIdType: 'MSISDN' | 'EMAIL' | 'PARTY_CODE', partyId: string }`
+  - `payerMessage`, `payeeNote`, `callbackUrl`: Same as Collections.
+
+#### `depositV2(request: DepositRequest)`
+Deposits money into a payee account using V2 specs.
+
+#### `refundV2(request: RefundRequest)`
+Refunds a previous transaction.
+- **Arguments**:
+  - `amount`, `currency`, `externalId`, `payerMessage`, `payeeNote`
+  - `referenceIdToRefund`: `string` (The original transaction ID)
+
+---
+
+### Remittance
+Manage cross-border transfers.
+
+#### `transfer(request: CashTransferRequest)`
+- **Additional Arguments**:
+  - `originatingCountry`: `string` (ISO code)
+  - `originalAmount`: `string`
+  - `originalCurrency`: `string`
+
+---
+
+## Going Live (Production)
+
+Transitioning from Sandbox to Production requires a few changes:
+
+1. **Environment Flag**:
+   Change `Environment.SANDBOX` to `Environment.PRODUCTION`.
+   ```ts
+   const momo = create({
+     callbackHost: "production-api.yoursite.com",
+     environment: Environment.PRODUCTION,
+   });
+   ```
+
+2. **Production Credentials**:
+   - Get your **Primary Key** from the [MTN MoMo Developer Portal](https://momodeveloper.mtn.com/).
+   - Obtain your production **User ID** and **User Secret** through the official onboarding process in your specific region.
+
+3. **Endpoints**:
+   The SDK handles the URL switch automatically when `Environment.PRODUCTION` is set.
+
+---
+
+## Environment Variables
+
+For security, it is highly recommended to store your credentials in environment variables (e.g., using `dotenv`):
+
+```bash
+# Collections
+COLLECTIONS_PRIMARY_KEY=your_key
+COLLECTIONS_USER_ID=your_id
+COLLECTIONS_USER_SECRET=your_secret
+
+# Disbursements
+DISBURSEMENTS_PRIMARY_KEY=your_key
+DISBURSEMENTS_USER_ID=your_id
+DISBURSEMENTS_USER_SECRET=your_secret
+
+# Remittance
+REMITTANCE_PRIMARY_KEY=your_key
+REMITTANCE_USER_ID=your_id
+REMITTANCE_USER_SECRET=your_secret
+```
+
+Usage in your application:
+
+```ts
+import "dotenv/config";
+
+const collections = momo.Collections({
+  primaryKey: process.env.COLLECTIONS_PRIMARY_KEY!,
+  userId: process.env.COLLECTIONS_USER_ID!,
+  userSecret: process.env.COLLECTIONS_USER_SECRET!,
+});
+```
+
+---
+
+## Development & Testing
+
+We use [Bun](https://bun.sh) for efficient development.
+
+```bash
+bun install
+bun run test         # Run unit tests
+bun run build        # Build for production (ESM/CJS)
+```
+
+## License
+ISC

package/lib/cjs/auth.d.ts

@@ -0,0 +1,17 @@
+import type { AxiosInstance } from "axios";
+import type { AccessToken, Config, UserConfig } from "./common";
+export type TokenRefresher = () => Promise<string>;
+export interface AuthorizerOptions {
+    grant_type?: string;
+    refresh_token?: string;
+}
+export type Authorizer = (config: Config, options?: AuthorizerOptions, client?: AxiosInstance) => Promise<AccessToken & {
+    refresh_token?: string;
+    refresh_token_expired_in?: number;
+}>;
+export declare function createTokenRefresher(authorize: Authorizer, config: Config): TokenRefresher;
+export declare const authorizeCollections: Authorizer;
+export declare const authorizeDisbursements: Authorizer;
+export declare const authorizeRemittance: Authorizer;
+export declare function createBasicAuthToken(config: UserConfig): string;
+//# sourceMappingURL=auth.d.ts.map

package/lib/cjs/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAI3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEhE,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;AAEnD,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,UAAU,GAAG,CACvB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,iBAAiB,EAC3B,MAAM,CAAC,EAAE,aAAa,KACnB,OAAO,CAAC,WAAW,GAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,wBAAwB,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAS1F,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,UAAU,EACrB,MAAM,EAAE,MAAM,GACb,cAAc,CAmChB;AASD,eAAO,MAAM,oBAAoB,EAAE,UAalC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,UAapC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAajC,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAI/D"}

package/lib/cjs/auth.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorizeRemittance = exports.authorizeDisbursements = exports.authorizeCollections = void 0;
+exports.createTokenRefresher = createTokenRefresher;
+exports.createBasicAuthToken = createBasicAuthToken;
+const client_1 = require("./client");
+function createTokenRefresher(authorize, config) {
+    let credentials;
+    return () => {
+        if (isExpired(credentials)) {
+            const isRefreshTokenValid = credentials?.refreshToken && !isRefreshExpired(credentials);
+            const options = isRefreshTokenValid
+                ? { grant_type: 'refresh_token', refresh_token: credentials.refreshToken }
+                : { grant_type: 'client_credentials' };
+            return authorize(config, options)
+                .then((tokenData) => {
+                const { access_token, expires_in, refresh_token, refresh_token_expired_in } = tokenData;
+                const expires = Date.now() + expires_in * 1000 - 60000;
+                let refreshExpires;
+                if (refresh_token_expired_in) {
+                    refreshExpires = Date.now() + refresh_token_expired_in * 1000 - 60000;
+                }
+                return {
+                    accessToken: access_token,
+                    expires,
+                    refreshToken: refresh_token,
+                    refreshExpires,
+                };
+            })
+                .then((freshCredentials) => {
+                credentials = freshCredentials;
+                return credentials.accessToken;
+            });
+        }
+        return Promise.resolve(credentials.accessToken);
+    };
+}
+function isRefreshExpired(credentials) {
+    if (!credentials || !credentials.refreshExpires) {
+        return true;
+    }
+    return Date.now() > credentials.refreshExpires;
+}
+const authorizeCollections = function (config, options, client = (0, client_1.createClient)(config)) {
+    const basicAuthToken = createBasicAuthToken(config);
+    return client
+        .post("/collection/token/", null, {
+        headers: {
+            Authorization: `Basic ${basicAuthToken}`,
+        },
+    })
+        .then((response) => response.data);
+};
+exports.authorizeCollections = authorizeCollections;
+const authorizeDisbursements = function (config, options, client = (0, client_1.createClient)(config)) {
+    const basicAuthToken = createBasicAuthToken(config);
+    return client
+        .post("/disbursement/token/", null, {
+        headers: {
+            Authorization: `Basic ${basicAuthToken}`,
+        },
+    })
+        .then((response) => response.data);
+};
+exports.authorizeDisbursements = authorizeDisbursements;
+const authorizeRemittance = function (config, options, client = (0, client_1.createClient)(config)) {
+    const basicAuthToken = createBasicAuthToken(config);
+    return client
+        .post("/remittance/token/", null, {
+        headers: {
+            Authorization: `Basic ${basicAuthToken}`,
+        },
+    })
+        .then((response) => response.data);
+};
+exports.authorizeRemittance = authorizeRemittance;
+function createBasicAuthToken(config) {
+    return Buffer.from(`${config.userId}:${config.userSecret}`).toString("base64");
+}
+function isExpired(credentials) {
+    if (!credentials || !credentials.expires) {
+        return true;
+    }
+    return Date.now() > credentials.expires;
+}
+//# sourceMappingURL=auth.js.map

package/lib/cjs/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":";;;AA0BA,oDAsCC;AAsDD,oDAIC;AAxHD,qCAAwC;AAwBxC,SAAgB,oBAAoB,CAClC,SAAqB,EACrB,MAAc;IAEd,IAAI,WAA6B,CAAC;IAClC,OAAO,GAAG,EAAE;QACV,IAAI,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3B,MAAM,mBAAmB,GAAG,WAAW,EAAE,YAAY,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAExF,MAAM,OAAO,GAAsB,mBAAmB;gBACpD,CAAC,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,WAAW,CAAC,YAAY,EAAE;gBAC1E,CAAC,CAAC,EAAE,UAAU,EAAE,oBAAoB,EAAE,CAAC;YAEzC,OAAO,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;iBAC9B,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;gBAClB,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,wBAAwB,EAAE,GAAG,SAAS,CAAC;gBACxF,MAAM,OAAO,GAAW,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,GAAG,IAAI,GAAG,KAAK,CAAC;gBAE/D,IAAI,cAAkC,CAAC;gBACvC,IAAI,wBAAwB,EAAE,CAAC;oBAC7B,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,wBAAwB,GAAG,IAAI,GAAG,KAAK,CAAC;gBACxE,CAAC;gBAED,OAAO;oBACL,WAAW,EAAE,YAAY;oBACzB,OAAO;oBACP,YAAY,EAAE,aAAa;oBAC3B,cAAc;iBACf,CAAC;YACJ,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBACzB,WAAW,GAAG,gBAAgB,CAAC;gBAC/B,OAAO,WAAW,CAAC,WAAW,CAAC;YACjC,CAAC,CAAC,CAAC;QACP,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,WAA6B;IACrD,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,cAAc,CAAC;AACjD,CAAC;AAEM,MAAM,oBAAoB,GAAe,UAC9C,MAAc,EACd,OAA2B,EAC3B,SAAwB,IAAA,qBAAY,EAAC,MAAM,CAAC;IAE5C,MAAM,cAAc,GAAW,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC5D,OAAO,MAAM;SACV,IAAI,CAAC,oBAAoB,EAAE,IAAI,EAAE;QAChC,OAAO,EAAE;YACP,aAAa,EAAE,SAAS,cAAc,EAAE;SACzC;KACF,CAAC;SACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC,CAAC;AAbW,QAAA,oBAAoB,wBAa/B;AAEK,MAAM,sBAAsB,GAAe,UAChD,MAAc,EACd,OAA2B,EAC3B,SAAwB,IAAA,qBAAY,EAAC,MAAM,CAAC;IAE5C,MAAM,cAAc,GAAW,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC5D,OAAO,MAAM;SACV,IAAI,CAAC,sBAAsB,EAAE,IAAI,EAAE;QAClC,OAAO,EAAE;YACP,aAAa,EAAE,SAAS,cAAc,EAAE;SACzC;KACF,CAAC;SACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC,CAAC;AAbW,QAAA,sBAAsB,0BAajC;AAEK,MAAM,mBAAmB,GAAe,UAC7C,MAAc,EACd,OAA2B,EAC3B,SAAwB,IAAA,qBAAY,EAAC,MAAM,CAAC;IAE5C,MAAM,cAAc,GAAW,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC5D,OAAO,MAAM;SACV,IAAI,CAAC,oBAAoB,EAAE,IAAI,EAAE;QAChC,OAAO,EAAE;YACP,aAAa,EAAE,SAAS,cAAc,EAAE;SACzC;KACF,CAAC;SACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC,CAAC;AAbW,QAAA,mBAAmB,uBAa9B;AAEF,SAAgB,oBAAoB,CAAC,MAAkB;IACrD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAClE,QAAQ,CACT,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,WAA6B;IAC9C,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC;AAC1C,CAAC"}

package/lib/cjs/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/lib/cjs/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":""}

package/lib/cjs/cli.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const momo = __importStar(require("./index"));
+const version = process.env.npm_package_version || "0.0.0";
+commander_1.program
+    .version(version)
+    .description("Create sandbox credentials")
+    .option("-x, --host <n>", "Your webhook host")
+    .option("-p, --primary-key <n>", "Primary Key")
+    .parse(process.argv);
+const options = commander_1.program.opts();
+if (!options.host || !options.primaryKey) {
+    commander_1.program.help({ error: true });
+}
+const stringify = (obj) => JSON.stringify(obj, null, 2);
+const { Users } = momo.create({ callbackHost: options.host });
+const users = Users({ primaryKey: options.primaryKey });
+users
+    .create(options.host)
+    .then((userId) => {
+    return users.login(userId).then((credentials) => {
+        console.log("Momo Sandbox Credentials", stringify({
+            userSecret: credentials.apiKey,
+            userId,
+        }));
+    });
+})
+    .catch((error) => {
+    console.log(error);
+});
+//# sourceMappingURL=cli.js.map

package/lib/cjs/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,yCAAoC;AAEpC,8CAAgC;AAIhC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC;AAE3D,mBAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,4BAA4B,CAAC;KACzC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC;KAC7C,MAAM,CAAC,uBAAuB,EAAE,aAAa,CAAC;KAC9C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAA0C,CAAC;AAEvE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;IACzC,mBAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,GAAoB,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAEzE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;AAE9D,MAAM,KAAK,GAAG,KAAK,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;AAExD,KAAK;KACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;KACpB,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE;IACvB,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,WAAwB,EAAE,EAAE;QAC3D,OAAO,CAAC,GAAG,CACT,0BAA0B,EAC1B,SAAS,CAAC;YACR,UAAU,EAAE,WAAW,CAAC,MAAM;YAC9B,MAAM;SACP,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;KACD,KAAK,CAAC,CAAC,KAAmB,EAAE,EAAE;IAC7B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC"}

package/lib/cjs/client.d.ts

@@ -0,0 +1,7 @@
+import type { AxiosInstance } from "axios";
+import type { TokenRefresher } from "./auth";
+import type { GlobalConfig, SubscriptionConfig } from "./common";
+export declare function createClient(config: SubscriptionConfig & GlobalConfig, client?: AxiosInstance): AxiosInstance;
+export declare function createAuthClient(refresh: TokenRefresher, client: AxiosInstance): AxiosInstance;
+export declare function withErrorHandling(client: AxiosInstance): AxiosInstance;
+//# sourceMappingURL=client.d.ts.map

package/lib/cjs/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAA8B,MAAM,OAAO,CAAC;AAIvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEjE,wBAAgB,YAAY,CAC1B,MAAM,EAAE,kBAAkB,GAAG,YAAY,EACzC,MAAM,GAAE,aAA8B,GACrC,aAAa,CAUf;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,aAAa,GACpB,aAAa,CAiBf;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAOtE"}

package/lib/cjs/client.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = createClient;
+exports.createAuthClient = createAuthClient;
+exports.withErrorHandling = withErrorHandling;
+const axios_1 = __importStar(require("axios"));
+const errors_1 = require("./errors");
+function createClient(config, client = axios_1.default.create()) {
+    if (config.baseUrl) {
+        client.defaults.baseURL = config.baseUrl;
+    }
+    client.defaults.headers.common["Ocp-Apim-Subscription-Key"] =
+        config.primaryKey;
+    client.defaults.headers.common["X-Target-Environment"] =
+        config.environment || "sandbox";
+    return withErrorHandling(client);
+}
+function createAuthClient(refresh, client) {
+    client.interceptors.request.use(async (request) => {
+        const accessToken = await refresh();
+        const headers = request.headers instanceof axios_1.AxiosHeaders
+            ? request.headers
+            : axios_1.AxiosHeaders.from(request.headers);
+        headers.set("Authorization", `Bearer ${accessToken}`);
+        request.headers = headers;
+        return request;
+    });
+    return client;
+}
+function withErrorHandling(client) {
+    client.interceptors.response.use((response) => response, (error) => Promise.reject((0, errors_1.handleError)(error)));
+    return client;
+}
+//# sourceMappingURL=client.js.map

package/lib/cjs/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,oCAaC;AAED,4CAoBC;AAED,8CAOC;AApDD,+CAA4C;AAG5C,qCAAuC;AAKvC,SAAgB,YAAY,CAC1B,MAAyC,EACzC,SAAwB,eAAK,CAAC,MAAM,EAAE;IAEtC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC3C,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC;QACzD,MAAM,CAAC,UAAU,CAAC;IACpB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;QACpD,MAAM,CAAC,WAAW,IAAI,SAAS,CAAC;IAElC,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED,SAAgB,gBAAgB,CAC9B,OAAuB,EACvB,MAAqB;IAErB,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAC7B,KAAK,EAAE,OAAmC,EAAE,EAAE;QAC5C,MAAM,WAAW,GAAG,MAAM,OAAO,EAAE,CAAC;QACpC,MAAM,OAAO,GACX,OAAO,CAAC,OAAO,YAAY,oBAAY;YACrC,CAAC,CAAC,OAAO,CAAC,OAAO;YACjB,CAAC,CAAC,oBAAY,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEzC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;QACtD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,OAAO,CAAC;IACjB,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iBAAiB,CAAC,MAAqB;IACrD,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAC9B,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EACtB,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,oBAAW,EAAC,KAAK,CAAC,CAAC,CAC9C,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/cjs/collections.d.ts

@@ -0,0 +1,176 @@
+import type { AxiosInstance } from "axios";
+import { type Balance, type BasicUserInfo, type BcAuthorizeRequest, type BcAuthorizeResponse, type Config, type DeliveryNotification, FailureReason, type Party, PartyIdType, TransactionStatus, type Withdrawal, type WithdrawalRequest } from "./common";
+export interface PaymentRequest {
+    /**
+     * Amount that will be debited from the payer account
+     */
+    amount: string;
+    /**
+     * ISO4217 Currency
+     */
+    currency: string;
+    /**
+     * External id is used as a reference to the transaction.
+     * External id is used for reconciliation.
+     * The external id will be included in transaction history report.
+     * External id is not required to be unique.
+     */
+    externalId?: string;
+    /**
+     * Party identifies a account holder in the wallet platform.
+     * Party consists of two parameters, type and partyId.
+     * Each type have its own validation of the partyId
+     *   - MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN
+     *   - EMAIL - Validated to be a valid e-mail format. Validated with IsEmail
+     *   - PARTY_CODE - UUID of the party. Validated with IsUuid
+     */
+    payer: Party;
+    /**
+     * Message that will be written in the payer transaction history message field.
+     */
+    payerMessage?: string;
+    /**
+     * Message that will be written in the payee transaction history note field.
+     */
+    payeeNote?: string;
+    /**
+     * URL to the server where the callback should be sent.
+     */
+    callbackUrl?: string;
+}
+export interface Payment {
+    /**
+     * Financial transactionIdd from mobile money manager.
+     * Used to connect to the specific financial transaction made in the account
+     */
+    financialTransactionId: string;
+    /**
+     * External id provided in the creation of the requestToPay transaction
+     */
+    externalId: string;
+    /**
+     * Amount that will be debited from the payer account.
+     */
+    amount: string;
+    /**
+     * ISO4217 Currency
+     */
+    currency: string;
+    /**
+     * Party identifies a account holder in the wallet platform.
+     * Party consists of two parameters, type and partyId.
+     * Each type have its own validation of the partyId
+     *   - MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN
+     *   - EMAIL - Validated to be a valid e-mail format. Validated with IsEmail
+     *   - PARTY_CODE - UUID of the party. Validated with IsUuid
+     */
+    payer: Party;
+    /**
+     * Message that will be written in the payer transaction history message field.
+     */
+    payerMessage: string;
+    /**
+     * Message that will be written in the payee transaction history note field.
+     */
+    payeeNote: string;
+    reason?: FailureReason;
+    status: TransactionStatus;
+}
+export default class Collections {
+    private client;
+    private config;
+    constructor(client: AxiosInstance, config: Config);
+    /**
+     * This method is used to request a payment from a consumer (Payer).
+     * The payer will be asked to authorize the payment. The transaction will
+     * be executed once the payer has authorized the payment.
+     * The requesttopay will be in status PENDING until the transaction
+     * is authorized or declined by the payer or it is timed out by the system.
+     * Status of the transaction can be validated by using `getTransation`
+     *
+     * @param paymentRequest
+     */
+    requestToPay({ callbackUrl, ...paymentRequest }: PaymentRequest): Promise<string>;
+    /**
+     * This method is used to retrieve transaction information. You can invoke it
+     * at intervals until your transaction fails or succeeds.
+     *
+     * If the transaction has failed, it will throw an appropriate error. The error will be a subclass
+     * of `MtnMoMoError`. Check [`src/error.ts`](https://github.com/maxkabechani/mtn-momo-sdk/blob/master/src/errors.ts)
+     * for the various errors that can be thrown
+     *
+     * @param referenceId the value returned from `requestToPay`
+     */
+    getTransaction(referenceId: string): Promise<Payment>;
+    /**
+     * Get the balance of the account.
+     */
+    getBalance(): Promise<Balance>;
+    /**
+     * This method is used to check if an account holder is registered and active in the system.
+     *
+     * @param id Specifies the type of the party ID. Allowed values [msisdn, email, party_code].
+     *   accountHolderId should explicitly be in small letters.
+     *
+     * @param type The party number. Validated according to the party ID type (case Sensitive).
+     *   msisdn - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN
+     *   email - Validated to be a valid e-mail format. Validated with IsEmail
+     *   party_code - UUID of the party. Validated with IsUuid
+     */
+    isPayerActive(id: string, type?: PartyIdType): Promise<boolean>;
+    /**
+     * This method is used to request a withdrawal from a payer account (V1).
+     * The payer will be asked to authorize the withdrawal.
+     *
+     * @param withdrawalRequest The withdrawal request details
+     * @returns A promise that resolves to the withdrawal reference ID
+     */
+    requestToWithdraw(withdrawalRequest: WithdrawalRequest): Promise<string>;
+    /**
+     * This method is used to request a withdrawal from a payer account (V2).
+     * The payer will be asked to authorize the withdrawal.
+     *
+     * @param withdrawalRequest The withdrawal request details
+     * @returns A promise that resolves to the withdrawal reference ID
+     */
+    requestToWithdrawV2(withdrawalRequest: WithdrawalRequest): Promise<string>;
+    /**
+     * Get the details and status of a withdrawal request.
+     *
+     * @param referenceId The withdrawal reference ID from requestToWithdraw
+     * @returns A promise that resolves to the withdrawal details
+     */
+    getWithdrawal(referenceId: string): Promise<Withdrawal>;
+    /**
+     * Send a delivery notification for a completed request to pay.
+     *
+     * @param referenceId The request to pay reference ID
+     * @param notification The delivery notification details
+     * @returns A promise that resolves when the notification is sent
+     */
+    sendDeliveryNotification(referenceId: string, notification: DeliveryNotification): Promise<void>;
+    /**
+     * Get basic user information for an account holder.
+     *
+     * @param partyIdType The type of party ID (MSISDN, EMAIL, or PARTY_CODE)
+     * @param partyId The party identifier
+     * @returns A promise that resolves to the basic user information
+     */
+    getBasicUserInfo(partyIdType: PartyIdType, partyId: string): Promise<BasicUserInfo>;
+    /**
+     * Get the balance of the account in a specific currency.
+     *
+     * @param currency The ISO4217 currency code
+     * @returns A promise that resolves to the account balance in the specified currency
+     */
+    getBalanceInCurrency(currency: string): Promise<Balance>;
+    /**
+     * Request Biometric Consent (BC) authorization.
+     * This initiates the BC authorization flow for enhanced security.
+     *
+     * @param request The BC authorization request
+     * @returns A promise that resolves to the BC authorization response with auth_req_id
+     */
+    bcAuthorize(request: BcAuthorizeRequest): Promise<BcAuthorizeResponse>;
+}
+//# sourceMappingURL=collections.d.ts.map

package/lib/cjs/collections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../../src/collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAM3C,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,aAAa,EACb,KAAK,KAAK,EACV,WAAW,EACX,iBAAiB,EACjB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACvB,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;OAOG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,MAAM,CAAS;gBAEX,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM;IAKjD;;;;;;;;;OASG;IACI,YAAY,CAAC,EAClB,WAAW,EACX,GAAG,cAAc,EAClB,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAcnC;;;;;;;;;OASG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa5D;;OAEG;IACI,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAMrC;;;;;;;;;;OAUG;IACI,aAAa,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,WAAgC,GACrC,OAAO,CAAC,OAAO,CAAC;IAUnB;;;;;;OAMG;IACI,iBAAiB,CACtB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,MAAM,CAAC;IA2BlB;;;;;;OAMG;IACI,mBAAmB,CACxB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,MAAM,CAAC;IA2BlB;;;;;OAKG;IACI,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAY9D;;;;;;OAMG;IACI,wBAAwB,CAC7B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,oBAAoB,GACjC,OAAO,CAAC,IAAI,CAAC;IAWhB;;;;;;OAMG;IACI,gBAAgB,CACrB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC;IAQzB;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/D;;;;;;OAMG;IACI,WAAW,CAChB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC;CAiBhC"}