@maxkabechani/mtn-momo-sdk 0.1.0

package/lib/cjs/disbursements.d.ts

@@ -0,0 +1,190 @@
+import type { AxiosInstance } from "axios";
+import type { Config } from "./common";
+import { type Balance, type BasicUserInfo, type BcAuthorizeRequest, type BcAuthorizeResponse, type Deposit, type DepositRequest, FailureReason, PartyIdType, type Refund, type RefundRequest, TransactionStatus } from "./common";
+export interface TransferRequest {
+    /**
+     * Unique Transfer Reference (UUID v4), will be automatically generated if not explicitly supplied
+     */
+    referenceId?: string;
+    /**
+     * 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
+     */
+    payee: {
+        partyIdType: PartyIdType;
+        partyId: string;
+    };
+    /**
+     * 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 Transfer {
+    /**
+     * Amount that will be debited from the payer account.
+     */
+    amount: string;
+    /**
+     * ISO4217 Currency
+     */
+    currency: string;
+    /**
+     * Financial transactionIdd from mobile money manager.
+     * Used to connect to the specific financial transaction made in the account
+     */
+    financialTransactionId: 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
+     */
+    payee: {
+        partyIdType: "MSISDN";
+        partyId: string;
+    };
+    status: TransactionStatus;
+    reason?: FailureReason;
+}
+export default class Disbursements {
+    private client;
+    private config;
+    constructor(client: AxiosInstance, config: Config);
+    /**
+     * Transfer operation is used to transfer an amount from the owner’s
+     * account to a payee account.
+     * Status of the transaction can be validated by using the
+     *
+     * @param paymentRequest
+     */
+    transfer({ callbackUrl, referenceId, ...payoutRequest }: TransferRequest): Promise<string>;
+    /**
+     * This method is used to retrieve the transaction. You can invoke this method
+     * to 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 `transfer`
+     */
+    getTransaction(referenceId: string): Promise<Transfer>;
+    /**
+     * 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>;
+    /**
+     * Deposit money into a payee account (V1).
+     *
+     * @param depositRequest The deposit request details
+     * @returns A promise that resolves to the deposit reference ID
+     */
+    deposit(depositRequest: DepositRequest): Promise<string>;
+    /**
+     * Deposit money into a payee account (V2).
+     *
+     * @param depositRequest The deposit request details
+     * @returns A promise that resolves to the deposit reference ID
+     */
+    depositV2(depositRequest: DepositRequest): Promise<string>;
+    /**
+     * Get the details and status of a deposit transaction.
+     *
+     * @param referenceId The deposit reference ID from deposit
+     * @returns A promise that resolves to the deposit details
+     */
+    getDeposit(referenceId: string): Promise<Deposit>;
+    /**
+     * Refund money from a previous transfer or deposit (V1).
+     *
+     * @param refundRequest The refund request details
+     * @returns A promise that resolves to the refund reference ID
+     */
+    refund(refundRequest: RefundRequest): Promise<string>;
+    /**
+     * Refund money from a previous transfer or deposit (V2).
+     *
+     * @param refundRequest The refund request details
+     * @returns A promise that resolves to the refund reference ID
+     */
+    refundV2(refundRequest: RefundRequest): Promise<string>;
+    /**
+     * Get the details and status of a refund transaction.
+     *
+     * @param referenceId The refund reference ID from refund
+     * @returns A promise that resolves to the refund details
+     */
+    getRefund(referenceId: string): Promise<Refund>;
+    /**
+     * 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=disbursements.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"disbursements.d.ts","sourceRoot":"","sources":["../../src/disbursements.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAM3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,aAAa,EACb,WAAW,EACX,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;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;QACL,WAAW,EAAE,WAAW,CAAC;QACzB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,EAAE;QACL,WAAW,EAAE,QAAQ,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,MAAM,CAAS;gBAEX,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM;IAKjD;;;;;;OAMG;IACI,QAAQ,CAAC,EACd,WAAW,EACX,WAAoB,EACpB,GAAG,aAAa,EACjB,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAapC;;;;;;;;;OASG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa7D;;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;IASnB;;;;;OAKG;IACI,OAAO,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IA2B/D;;;;;OAKG;IACI,SAAS,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BjE;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYxD;;;;;OAKG;IACI,MAAM,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAwB5D;;;;;OAKG;IACI,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAwB9D;;;;;OAKG;IACI,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYtD;;;;;;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;CAoBhC"}

package/lib/cjs/disbursements.js

@@ -0,0 +1,268 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const uuid_1 = require("uuid");
+const errors_1 = require("./errors");
+const validate_1 = require("./validate");
+const auth_1 = require("./auth");
+const common_1 = require("./common");
+class Disbursements {
+    constructor(client, config) {
+        this.client = client;
+        this.config = config;
+    }
+    /**
+     * Transfer operation is used to transfer an amount from the owner’s
+     * account to a payee account.
+     * Status of the transaction can be validated by using the
+     *
+     * @param paymentRequest
+     */
+    transfer({ callbackUrl, referenceId = (0, uuid_1.v4)(), ...payoutRequest }) {
+        return (0, validate_1.validateTransfer)({ referenceId, ...payoutRequest }).then(() => {
+            return this.client
+                .post("/disbursement/v1_0/transfer", payoutRequest, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(callbackUrl ? { "X-Callback-Url": callbackUrl } : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * This method is used to retrieve the transaction. You can invoke this method
+     * to 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 `transfer`
+     */
+    getTransaction(referenceId) {
+        return this.client
+            .get(`/disbursement/v1_0/transfer/${referenceId}`)
+            .then((response) => response.data)
+            .then((transaction) => {
+            if (transaction.status === common_1.TransactionStatus.FAILED) {
+                return Promise.reject((0, errors_1.getTransactionError)(transaction));
+            }
+            return Promise.resolve(transaction);
+        });
+    }
+    /**
+     * Get the balance of the account.
+     */
+    getBalance() {
+        return this.client
+            .get("/disbursement/v1_0/account/balance")
+            .then((response) => response.data);
+    }
+    /**
+     * 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, type = common_1.PartyIdType.MSISDN) {
+        return this.client
+            .get(`/disbursement/v1_0/accountholder/${type}/${id}/active`)
+            .then((response) => response.data)
+            .then((data) => (data.result !== undefined ? data.result : false));
+    }
+    /**
+     * Deposit money into a payee account (V1).
+     *
+     * @param depositRequest The deposit request details
+     * @returns A promise that resolves to the deposit reference ID
+     */
+    deposit(depositRequest) {
+        const referenceId = (0, uuid_1.v4)();
+        return (0, validate_1.validateDepositRequest)(depositRequest).then(() => {
+            return this.client
+                .post("/disbursement/v1_0/deposit", {
+                amount: depositRequest.amount,
+                currency: depositRequest.currency,
+                externalId: depositRequest.externalId,
+                payee: depositRequest.payee,
+                payerMessage: depositRequest.payerMessage,
+                payeeNote: depositRequest.payeeNote,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(depositRequest.callbackUrl
+                        ? { "X-Callback-Url": depositRequest.callbackUrl }
+                        : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * Deposit money into a payee account (V2).
+     *
+     * @param depositRequest The deposit request details
+     * @returns A promise that resolves to the deposit reference ID
+     */
+    depositV2(depositRequest) {
+        const referenceId = (0, uuid_1.v4)();
+        return (0, validate_1.validateDepositRequest)(depositRequest).then(() => {
+            return this.client
+                .post("/disbursement/v2_0/deposit", {
+                amount: depositRequest.amount,
+                currency: depositRequest.currency,
+                externalId: depositRequest.externalId,
+                payee: depositRequest.payee,
+                payerMessage: depositRequest.payerMessage,
+                payeeNote: depositRequest.payeeNote,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(depositRequest.callbackUrl
+                        ? { "X-Callback-Url": depositRequest.callbackUrl }
+                        : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * Get the details and status of a deposit transaction.
+     *
+     * @param referenceId The deposit reference ID from deposit
+     * @returns A promise that resolves to the deposit details
+     */
+    getDeposit(referenceId) {
+        return this.client
+            .get(`/disbursement/v1_0/deposit/${referenceId}`)
+            .then((response) => response.data)
+            .then((deposit) => {
+            if (deposit.status === common_1.TransactionStatus.FAILED) {
+                return Promise.reject((0, errors_1.getTransactionError)(deposit));
+            }
+            return Promise.resolve(deposit);
+        });
+    }
+    /**
+     * Refund money from a previous transfer or deposit (V1).
+     *
+     * @param refundRequest The refund request details
+     * @returns A promise that resolves to the refund reference ID
+     */
+    refund(refundRequest) {
+        const referenceId = (0, uuid_1.v4)();
+        return (0, validate_1.validateRefundRequest)(refundRequest).then(() => {
+            return this.client
+                .post("/disbursement/v1_0/refund", {
+                amount: refundRequest.amount,
+                currency: refundRequest.currency,
+                externalId: refundRequest.externalId,
+                payerMessage: refundRequest.payerMessage,
+                payeeNote: refundRequest.payeeNote,
+                referenceIdToRefund: refundRequest.referenceIdToRefund,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * Refund money from a previous transfer or deposit (V2).
+     *
+     * @param refundRequest The refund request details
+     * @returns A promise that resolves to the refund reference ID
+     */
+    refundV2(refundRequest) {
+        const referenceId = (0, uuid_1.v4)();
+        return (0, validate_1.validateRefundRequest)(refundRequest).then(() => {
+            return this.client
+                .post("/disbursement/v2_0/refund", {
+                amount: refundRequest.amount,
+                currency: refundRequest.currency,
+                externalId: refundRequest.externalId,
+                payerMessage: refundRequest.payerMessage,
+                payeeNote: refundRequest.payeeNote,
+                referenceIdToRefund: refundRequest.referenceIdToRefund,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * Get the details and status of a refund transaction.
+     *
+     * @param referenceId The refund reference ID from refund
+     * @returns A promise that resolves to the refund details
+     */
+    getRefund(referenceId) {
+        return this.client
+            .get(`/disbursement/v1_0/refund/${referenceId}`)
+            .then((response) => response.data)
+            .then((refund) => {
+            if (refund.status === common_1.TransactionStatus.FAILED) {
+                return Promise.reject((0, errors_1.getTransactionError)(refund));
+            }
+            return Promise.resolve(refund);
+        });
+    }
+    /**
+     * 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, partyId) {
+        return this.client
+            .get(`/disbursement/v1_0/accountholder/${partyIdType}/${partyId}/basicuserinfo`)
+            .then((response) => response.data);
+    }
+    /**
+     * 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) {
+        return this.client
+            .get(`/disbursement/v1_0/account/balance/${currency}`)
+            .then((response) => response.data);
+    }
+    /**
+     * 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) {
+        const params = new URLSearchParams();
+        params.append("login_hint", request.login_hint);
+        params.append("scope", request.scope);
+        params.append("access_type", request.access_type);
+        if (request.consent_valid_in) {
+            params.append("consent_valid_in", String(request.consent_valid_in));
+        }
+        const basicAuthToken = (0, auth_1.createBasicAuthToken)(this.config);
+        return this.client
+            .post("/disbursement/v1_0/bc-authorize", params, {
+            headers: {
+                Authorization: `Basic ${basicAuthToken}`,
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+        })
+            .then((response) => response.data);
+    }
+}
+exports.default = Disbursements;
+//# sourceMappingURL=disbursements.js.map

package/lib/cjs/disbursements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"disbursements.js","sourceRoot":"","sources":["../../src/disbursements.ts"],"names":[],"mappings":";;AACA,+BAAkC;AAElC,qCAA+C;AAC/C,yCAA6F;AAC7F,iCAA8C;AAG9C,qCAYkB;AA6FlB,MAAqB,aAAa;IAIhC,YAAY,MAAqB,EAAE,MAAc;QAC/C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,EACd,WAAW,EACX,WAAW,GAAG,IAAA,SAAI,GAAE,EACpB,GAAG,aAAa,EACA;QAChB,OAAO,IAAA,2BAAgB,EAAC,EAAE,WAAW,EAAE,GAAG,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACnE,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CAAO,6BAA6B,EAAE,aAAa,EAAE;gBACxD,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;oBAC7B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1D;aACF,CAAC;iBACD,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,cAAc,CAAC,WAAmB;QACvC,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAW,+BAA+B,WAAW,EAAE,CAAC;aAC3D,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;YACpB,IAAI,WAAW,CAAC,MAAM,KAAK,0BAAiB,CAAC,MAAM,EAAE,CAAC;gBACpD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAA,4BAAmB,EAAC,WAAW,CAAC,CAAC,CAAC;YAC1D,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAU,oCAAoC,CAAC;aAClD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;OAUG;IACI,aAAa,CAClB,EAAU,EACV,OAAoB,oBAAW,CAAC,MAAM;QAEtC,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CACF,oCAAoC,IAAI,IAAI,EAAE,SAAS,CACxD;aACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,cAA8B;QAC3C,MAAM,WAAW,GAAW,IAAA,SAAI,GAAE,CAAC;QACnC,OAAO,IAAA,iCAAsB,EAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACtD,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,4BAA4B,EAC5B;gBACE,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,QAAQ,EAAE,cAAc,CAAC,QAAQ;gBACjC,UAAU,EAAE,cAAc,CAAC,UAAU;gBACrC,KAAK,EAAE,cAAc,CAAC,KAAK;gBAC3B,YAAY,EAAE,cAAc,CAAC,YAAY;gBACzC,SAAS,EAAE,cAAc,CAAC,SAAS;aACpC,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;oBAC7B,GAAG,CAAC,cAAc,CAAC,WAAW;wBAC5B,CAAC,CAAC,EAAE,gBAAgB,EAAE,cAAc,CAAC,WAAW,EAAE;wBAClD,CAAC,CAAC,EAAE,CAAC;iBACR;aACF,CACF;iBACA,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,cAA8B;QAC7C,MAAM,WAAW,GAAW,IAAA,SAAI,GAAE,CAAC;QACnC,OAAO,IAAA,iCAAsB,EAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACtD,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,4BAA4B,EAC5B;gBACE,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,QAAQ,EAAE,cAAc,CAAC,QAAQ;gBACjC,UAAU,EAAE,cAAc,CAAC,UAAU;gBACrC,KAAK,EAAE,cAAc,CAAC,KAAK;gBAC3B,YAAY,EAAE,cAAc,CAAC,YAAY;gBACzC,SAAS,EAAE,cAAc,CAAC,SAAS;aACpC,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;oBAC7B,GAAG,CAAC,cAAc,CAAC,WAAW;wBAC5B,CAAC,CAAC,EAAE,gBAAgB,EAAE,cAAc,CAAC,WAAW,EAAE;wBAClD,CAAC,CAAC,EAAE,CAAC;iBACR;aACF,CACF;iBACA,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,WAAmB;QACnC,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAU,8BAA8B,WAAW,EAAE,CAAC;aACzD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAChB,IAAI,OAAO,CAAC,MAAM,KAAK,0BAAiB,CAAC,MAAM,EAAE,CAAC;gBAChD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAA4B;QACxC,MAAM,WAAW,GAAW,IAAA,SAAI,GAAE,CAAC;QACnC,OAAO,IAAA,gCAAqB,EAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACpD,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,2BAA2B,EAC3B;gBACE,MAAM,EAAE,aAAa,CAAC,MAAM;gBAC5B,QAAQ,EAAE,aAAa,CAAC,QAAQ;gBAChC,UAAU,EAAE,aAAa,CAAC,UAAU;gBACpC,YAAY,EAAE,aAAa,CAAC,YAAY;gBACxC,SAAS,EAAE,aAAa,CAAC,SAAS;gBAClC,mBAAmB,EAAE,aAAa,CAAC,mBAAmB;aACvD,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;iBAC9B;aACF,CACF;iBACA,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,aAA4B;QAC1C,MAAM,WAAW,GAAW,IAAA,SAAI,GAAE,CAAC;QACnC,OAAO,IAAA,gCAAqB,EAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACpD,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,2BAA2B,EAC3B;gBACE,MAAM,EAAE,aAAa,CAAC,MAAM;gBAC5B,QAAQ,EAAE,aAAa,CAAC,QAAQ;gBAChC,UAAU,EAAE,aAAa,CAAC,UAAU;gBACpC,YAAY,EAAE,aAAa,CAAC,YAAY;gBACxC,SAAS,EAAE,aAAa,CAAC,SAAS;gBAClC,mBAAmB,EAAE,aAAa,CAAC,mBAAmB;aACvD,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;iBAC9B;aACF,CACF;iBACA,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,WAAmB;QAClC,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAS,6BAA6B,WAAW,EAAE,CAAC;aACvD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,IAAI,MAAM,CAAC,MAAM,KAAK,0BAAiB,CAAC,MAAM,EAAE,CAAC;gBAC/C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAA,4BAAmB,EAAC,MAAM,CAAC,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CACrB,WAAwB,EACxB,OAAe;QAEf,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CACF,oCAAoC,WAAW,IAAI,OAAO,gBAAgB,CAC3E;aACA,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAAgB;QAC1C,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAU,sCAAsC,QAAQ,EAAE,CAAC;aAC9D,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAChB,OAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,cAAc,GAAW,IAAA,2BAAoB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjE,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAsB,iCAAiC,EAAE,MAAM,EAAE;YACpE,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,cAAc,EAAE;gBACxC,cAAc,EAAE,mCAAmC;aACpD;SACF,CAAC;aACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF;AArTD,gCAqTC"}

package/lib/cjs/errors.d.ts

@@ -0,0 +1,67 @@
+import type { AxiosError } from "axios";
+import type { Payment } from "./collections";
+import type { Deposit, Refund, Withdrawal } from "./common";
+import { FailureReason } from "./common";
+import type { Transfer } from "./disbursements";
+export declare class MtnMoMoError extends Error {
+    transaction?: Payment | Transfer;
+    constructor(message?: string);
+}
+export declare class ApprovalRejectedError extends MtnMoMoError {
+    name: string;
+}
+export declare class ExpiredError extends MtnMoMoError {
+    name: string;
+}
+export declare class InternalProcessingError extends MtnMoMoError {
+    name: string;
+}
+export declare class InvalidCallbackUrlHostError extends MtnMoMoError {
+    name: string;
+}
+export declare class InvalidCurrencyError extends MtnMoMoError {
+    name: string;
+}
+export declare class NotAllowedTargetEnvironmentError extends MtnMoMoError {
+    name: string;
+}
+export declare class NotAllowedError extends MtnMoMoError {
+    name: string;
+}
+export declare class NotEnoughFundsError extends MtnMoMoError {
+    name: string;
+}
+export declare class PayeeNotFoundError extends MtnMoMoError {
+    name: string;
+}
+export declare class PayeeNotAllowedToReceiveError extends MtnMoMoError {
+    name: string;
+}
+export declare class PayerLimitReachedError extends MtnMoMoError {
+    name: string;
+}
+export declare class PayerNotFoundError extends MtnMoMoError {
+    name: string;
+}
+export declare class PaymentNotApprovedError extends MtnMoMoError {
+    name: string;
+}
+export declare class ResourceAlreadyExistError extends MtnMoMoError {
+    name: string;
+}
+export declare class ResourceNotFoundError extends MtnMoMoError {
+    name: string;
+}
+export declare class ServiceUnavailableError extends MtnMoMoError {
+    name: string;
+}
+export declare class TransactionCancelledError extends MtnMoMoError {
+    name: string;
+}
+export declare class UnspecifiedError extends MtnMoMoError {
+    name: string;
+}
+export declare function handleError(error: AxiosError): Error;
+export declare function getError(code?: FailureReason, message?: string): ApprovalRejectedError | ExpiredError | InternalProcessingError | InvalidCallbackUrlHostError | InvalidCurrencyError | NotAllowedTargetEnvironmentError | NotAllowedError | NotEnoughFundsError | PayeeNotFoundError | PayeeNotAllowedToReceiveError | PayerLimitReachedError | PayerNotFoundError | PaymentNotApprovedError | ResourceAlreadyExistError | ResourceNotFoundError | ServiceUnavailableError | TransactionCancelledError | UnspecifiedError;
+export declare function getTransactionError(transaction: Payment | Transfer | Withdrawal | Deposit | Refund): MtnMoMoError;
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAOhD,qBAAa,YAAa,SAAQ,KAAK;IAC9B,WAAW,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;gBAE5B,OAAO,CAAC,EAAE,MAAM;CAI7B;AAED,qBAAa,qBAAsB,SAAQ,YAAY;IACrC,IAAI,SAA2B;CAChD;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5B,IAAI,SAAkB;CACvC;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvC,IAAI,SAA6B;CAClD;AAED,qBAAa,2BAA4B,SAAQ,YAAY;IAC3C,IAAI,SAAiC;CACtD;AAED,qBAAa,oBAAqB,SAAQ,YAAY;IACpC,IAAI,SAA0B;CAC/C;AAED,qBAAa,gCAAiC,SAAQ,YAAY;IAChD,IAAI,SAAsC;CAC3D;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAC/B,IAAI,SAAqB;CAC1C;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnC,IAAI,SAAyB;CAC9C;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClC,IAAI,SAAwB;CAC7C;AAED,qBAAa,6BAA8B,SAAQ,YAAY;IAC7C,IAAI,SAAmC;CACxD;AAED,qBAAa,sBAAuB,SAAQ,YAAY;IACtC,IAAI,SAA4B;CACjD;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClC,IAAI,SAAwB;CAC7C;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvC,IAAI,SAA6B;CAClD;AAED,qBAAa,yBAA0B,SAAQ,YAAY;IACzC,IAAI,SAA+B;CACpD;AAED,qBAAa,qBAAsB,SAAQ,YAAY;IACrC,IAAI,SAA2B;CAChD;AAED,qBAAa,uBAAwB,SAAQ,YAAY;IACvC,IAAI,SAA6B;CAClD;AAED,qBAAa,yBAA0B,SAAQ,YAAY;IACzC,IAAI,SAA+B;CACpD;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAChC,IAAI,SAAsB;CAC3C;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,CAQpD;AAED,wBAAgB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,4bAsE9D;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,gBAMhE"}