@maxkabechani/mtn-momo-sdk 0.1.0

package/lib/esm/collections.js

@@ -0,0 +1,216 @@
+import { v4 as uuid } from "uuid";
+import { getTransactionError } from "./errors";
+import { validateRequestToPay, validateWithdrawalRequest } from "./validate";
+import { FailureReason, PartyIdType, TransactionStatus, } from "./common";
+export default class Collections {
+    constructor(client, config) {
+        this.client = client;
+        this.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 }) {
+        return validateRequestToPay(paymentRequest).then(() => {
+            const referenceId = uuid();
+            return this.client
+                .post("/collection/v1_0/requesttopay", paymentRequest, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(callbackUrl ? { "X-Callback-Url": callbackUrl } : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * 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) {
+        return this.client
+            .get(`/collection/v1_0/requesttopay/${referenceId}`)
+            .then((response) => response.data)
+            .then((transaction) => {
+            if (transaction.status === TransactionStatus.FAILED) {
+                return Promise.reject(getTransactionError(transaction));
+            }
+            return Promise.resolve(transaction);
+        });
+    }
+    /**
+     * Get the balance of the account.
+     */
+    getBalance() {
+        return this.client
+            .get("/collection/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 = PartyIdType.MSISDN) {
+        // OpenAPI says msisdn/email should be lowercase for some endpoints
+        return this.client
+            .get(`/collection/v1_0/accountholder/${type}/${id}/active`)
+            .then((response) => response.data)
+            .then((data) => (data.result !== undefined ? data.result : false));
+    }
+    /**
+     * 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) {
+        const referenceId = uuid();
+        return validateWithdrawalRequest(withdrawalRequest).then(() => {
+            return this.client
+                .post("/collection/v1_0/requesttowithdraw", {
+                amount: withdrawalRequest.amount,
+                currency: withdrawalRequest.currency,
+                externalId: withdrawalRequest.externalId,
+                payee: withdrawalRequest.payee,
+                payerMessage: withdrawalRequest.payerMessage,
+                payeeNote: withdrawalRequest.payeeNote,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(withdrawalRequest.callbackUrl
+                        ? { "X-Callback-Url": withdrawalRequest.callbackUrl }
+                        : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * 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) {
+        const referenceId = uuid();
+        return validateWithdrawalRequest(withdrawalRequest).then(() => {
+            return this.client
+                .post("/collection/v2_0/requesttowithdraw", {
+                amount: withdrawalRequest.amount,
+                currency: withdrawalRequest.currency,
+                externalId: withdrawalRequest.externalId,
+                payee: withdrawalRequest.payee,
+                payerMessage: withdrawalRequest.payerMessage,
+                payeeNote: withdrawalRequest.payeeNote,
+            }, {
+                headers: {
+                    "X-Reference-Id": referenceId,
+                    ...(withdrawalRequest.callbackUrl
+                        ? { "X-Callback-Url": withdrawalRequest.callbackUrl }
+                        : {}),
+                },
+            })
+                .then(() => referenceId);
+        });
+    }
+    /**
+     * 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) {
+        return this.client
+            .get(`/collection/v1_0/requesttowithdraw/${referenceId}`)
+            .then((response) => response.data)
+            .then((withdrawal) => {
+            if (withdrawal.status === TransactionStatus.FAILED) {
+                return Promise.reject(getTransactionError(withdrawal));
+            }
+            return Promise.resolve(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, notification) {
+        return this.client
+            .post(`/collection/v1_0/requesttopay/${referenceId}/deliverynotification`, {
+            notificationMessage: notification.notificationMessage,
+        })
+            .then(() => undefined);
+    }
+    /**
+     * 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(`/collection/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(`/collection/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));
+        }
+        return this.client
+            .post("/collection/v1_0/bc-authorize", params, {
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+        })
+            .then((response) => response.data);
+    }
+}
+//# sourceMappingURL=collections.js.map

package/lib/esm/collections.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/collections.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAE7E,OAAO,EAOL,aAAa,EAEb,WAAW,EACX,iBAAiB,GAGlB,MAAM,UAAU,CAAC;AA8FlB,MAAM,CAAC,OAAO,OAAO,WAAW;IAI9B,YAAY,MAAqB,EAAE,MAAc;QAC/C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;OASG;IACI,YAAY,CAAC,EAClB,WAAW,EACX,GAAG,cAAc,EACF;QACf,OAAO,oBAAoB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACpD,MAAM,WAAW,GAAW,IAAI,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CAAO,+BAA+B,EAAE,cAAc,EAAE;gBAC3D,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,CAAU,iCAAiC,WAAW,EAAE,CAAC;aAC5D,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;YACpB,IAAI,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;gBACpD,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,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,kCAAkC,CAAC;aAChD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;OAUG;IACI,aAAa,CAClB,EAAU,EACV,OAAoB,WAAW,CAAC,MAAM;QAEtC,mEAAmE;QACnE,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CACF,kCAAkC,IAAI,IAAI,EAAE,SAAS,CACtD;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;;;;;;OAMG;IACI,iBAAiB,CACtB,iBAAoC;QAEpC,MAAM,WAAW,GAAW,IAAI,EAAE,CAAC;QACnC,OAAO,yBAAyB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YAC5D,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,oCAAoC,EACpC;gBACE,MAAM,EAAE,iBAAiB,CAAC,MAAM;gBAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;gBACpC,UAAU,EAAE,iBAAiB,CAAC,UAAU;gBACxC,KAAK,EAAE,iBAAiB,CAAC,KAAK;gBAC9B,YAAY,EAAE,iBAAiB,CAAC,YAAY;gBAC5C,SAAS,EAAE,iBAAiB,CAAC,SAAS;aACvC,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;oBAC7B,GAAG,CAAC,iBAAiB,CAAC,WAAW;wBAC/B,CAAC,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,WAAW,EAAE;wBACrD,CAAC,CAAC,EAAE,CAAC;iBACR;aACF,CACF;iBACA,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CACxB,iBAAoC;QAEpC,MAAM,WAAW,GAAW,IAAI,EAAE,CAAC;QACnC,OAAO,yBAAyB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YAC5D,OAAO,IAAI,CAAC,MAAM;iBACf,IAAI,CACH,oCAAoC,EACpC;gBACE,MAAM,EAAE,iBAAiB,CAAC,MAAM;gBAChC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;gBACpC,UAAU,EAAE,iBAAiB,CAAC,UAAU;gBACxC,KAAK,EAAE,iBAAiB,CAAC,KAAK;gBAC9B,YAAY,EAAE,iBAAiB,CAAC,YAAY;gBAC5C,SAAS,EAAE,iBAAiB,CAAC,SAAS;aACvC,EACD;gBACE,OAAO,EAAE;oBACP,gBAAgB,EAAE,WAAW;oBAC7B,GAAG,CAAC,iBAAiB,CAAC,WAAW;wBAC/B,CAAC,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,WAAW,EAAE;wBACrD,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,aAAa,CAAC,WAAmB;QACtC,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAa,sCAAsC,WAAW,EAAE,CAAC;aACpE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;aACjC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;YACnB,IAAI,UAAU,CAAC,MAAM,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;gBACnD,OAAO,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACI,wBAAwB,CAC7B,WAAmB,EACnB,YAAkC;QAElC,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CACH,iCAAiC,WAAW,uBAAuB,EACnE;YACE,mBAAmB,EAAE,YAAY,CAAC,mBAAmB;SACtD,CACF;aACA,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CACrB,WAAwB,EACxB,OAAe;QAEf,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CACF,kCAAkC,WAAW,IAAI,OAAO,gBAAgB,CACzE;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,oCAAoC,QAAQ,EAAE,CAAC;aAC5D,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,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAsB,+BAA+B,EAAE,MAAM,EAAE;YAClE,OAAO,EAAE;gBACP,cAAc,EAAE,mCAAmC;aACpD;SACF,CAAC;aACD,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACF"}

package/lib/esm/common.d.ts

@@ -0,0 +1,299 @@
+export type Config = GlobalConfig & ProductConfig;
+export type ProductConfig = SubscriptionConfig & UserConfig;
+export interface GlobalConfig {
+    /**
+     * The provider callback host
+     */
+    callbackHost?: string;
+    /**
+     * The base URL of the EWP system where the transaction shall be processed.
+     * This parameter is used to route the request to the EWP system that will
+     * initiate the transaction.
+     */
+    baseUrl?: string;
+    /**
+     * The identifier of the EWP system where the transaction shall be processed.
+     * This parameter is used to route the request to the EWP system that will
+     * initiate the transaction.
+     */
+    environment?: Environment;
+}
+export interface SubscriptionConfig {
+    /**
+     * Subscription key which provides access to this API. Found in your Profile
+     */
+    primaryKey: string;
+}
+export interface UserConfig {
+    /**
+     * The API user's key
+     */
+    userSecret: string;
+    /**
+     * Recource ID for the API user
+     */
+    userId: string;
+}
+export interface Credentials {
+    apiKey: string;
+}
+export interface ApiUserInfo {
+    providerCallbackHost?: string;
+    paymentServerUrl?: {
+        apiKey?: string;
+    };
+    targetEnvironment?: {
+        apiKey?: string;
+    };
+}
+export interface AccessToken {
+    /**
+     * A JWT token which can be used to authrize against the other API end-points.
+     * The format of the token follows the JWT standard format (see jwt.io for an example).
+     * This is the token that should be sent in in the Authorization header when calling the other API end-points.
+     */
+    access_token: string;
+    /**
+     * The token type.
+     *
+     * TODO: Find list of complete token types
+     */
+    token_type: string;
+    /**
+     * The validity time in seconds of the token
+     */
+    expires_in: number;
+}
+/**
+ * The available balance of the account
+ */
+export interface Balance {
+    /**
+     * The available balance of the account
+     */
+    availableBalance: string;
+    /**
+     * ISO4217 Currency
+     */
+    currency: string;
+}
+export interface Party {
+    partyIdType: PartyIdType;
+    partyId: string;
+}
+export declare enum PartyIdType {
+    MSISDN = "MSISDN",
+    EMAIL = "EMAIL",
+    PARTY_CODE = "PARTY_CODE"
+}
+export declare enum Environment {
+    SANDBOX = "sandbox",
+    PRODUCTION = "production"
+}
+export declare enum TransactionStatus {
+    SUCCESSFUL = "SUCCESSFUL",
+    PENDING = "PENDING",
+    FAILED = "FAILED"
+}
+export declare enum FailureReason {
+    PAYEE_NOT_FOUND = "PAYEE_NOT_FOUND",
+    PAYER_NOT_FOUND = "PAYER_NOT_FOUND",
+    NOT_ALLOWED = "NOT_ALLOWED",
+    NOT_ALLOWED_TARGET_ENVIRONMENT = "NOT_ALLOWED_TARGET_ENVIRONMENT",
+    INVALID_CALLBACK_URL_HOST = "INVALID_CALLBACK_URL_HOST",
+    INVALID_CURRENCY = "INVALID_CURRENCY",
+    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
+    INTERNAL_PROCESSING_ERROR = "INTERNAL_PROCESSING_ERROR",
+    NOT_ENOUGH_FUNDS = "NOT_ENOUGH_FUNDS",
+    PAYER_LIMIT_REACHED = "PAYER_LIMIT_REACHED",
+    PAYEE_NOT_ALLOWED_TO_RECEIVE = "PAYEE_NOT_ALLOWED_TO_RECEIVE",
+    PAYMENT_NOT_APPROVED = "PAYMENT_NOT_APPROVED",
+    RESOURCE_NOT_FOUND = "RESOURCE_NOT_FOUND",
+    APPROVAL_REJECTED = "APPROVAL_REJECTED",
+    EXPIRED = "EXPIRED",
+    TRANSACTION_CANCELED = "TRANSACTION_CANCELED",
+    RESOURCE_ALREADY_EXIST = "RESOURCE_ALREADY_EXIST"
+}
+/**
+ * Basic user information response
+ */
+export interface BasicUserInfo {
+    given_name?: string;
+    family_name?: string;
+    birthdate?: string;
+    locale?: string;
+    gender?: string;
+    status?: string;
+}
+/**
+ * Biometric Consent (BC) authorization response
+ */
+export interface BcAuthorizeResponse {
+    auth_req_id: string;
+    interval: number;
+    expires_in: number;
+}
+/**
+ * OAuth2 token response
+ */
+export interface OAuth2TokenResponse {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    scope?: string;
+    refresh_token?: string;
+    refresh_token_expired_in?: number;
+}
+/**
+ * Consent/KYC response with user information
+ */
+export interface ConsentKycResponse {
+    sub?: string;
+    name?: string;
+    given_name?: string;
+    family_name?: string;
+    middle_name?: string;
+    email?: string;
+    email_verified?: boolean;
+    gender?: string;
+    locale?: string;
+    phone_number?: string;
+    phone_number_verified?: boolean;
+    address?: string;
+    updated_at?: number;
+    status?: string;
+    birthdate?: string;
+    credit_score?: string;
+    active?: boolean;
+    country_of_birth?: string;
+    region_of_birth?: string;
+    city_of_birth?: string;
+    occupation?: string;
+    employer_name?: string;
+    identification_type?: string;
+    identification_value?: string;
+}
+/**
+ * Request to withdraw (Collections)
+ */
+export interface WithdrawalRequest {
+    amount: string;
+    currency: string;
+    externalId?: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    callbackUrl?: string;
+}
+/**
+ * Withdrawal result (Collections)
+ */
+export interface Withdrawal {
+    amount: string;
+    currency: string;
+    financialTransactionId: string;
+    externalId: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    status: TransactionStatus;
+    reason?: FailureReason;
+}
+/**
+ * Delivery notification request
+ */
+export interface DeliveryNotification {
+    notificationMessage: string;
+}
+/**
+ * Biometric Consent (BC) authorization request
+ */
+export interface BcAuthorizeRequest {
+    login_hint: string;
+    scope: string;
+    access_type: "online" | "offline";
+    consent_valid_in?: number;
+    client_notification_token?: string;
+    scope_instruction?: string;
+}
+/**
+ * Deposit request (Disbursements v1_0)
+ */
+export interface DepositRequest {
+    amount: string;
+    currency: string;
+    externalId?: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    callbackUrl?: string;
+}
+/**
+ * Deposit result (Disbursements v1_0)
+ */
+export interface Deposit {
+    amount: string;
+    currency: string;
+    financialTransactionId: string;
+    externalId: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    status: TransactionStatus;
+    reason?: FailureReason;
+}
+/**
+ * Refund request (Disbursements v1_0)
+ */
+export interface RefundRequest {
+    amount: string;
+    currency: string;
+    externalId?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+    referenceIdToRefund: string;
+}
+/**
+ * Refund result (Disbursements v1_0)
+ */
+export interface Refund {
+    amount: string;
+    currency: string;
+    financialTransactionId: string;
+    externalId: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    status: TransactionStatus;
+    reason?: FailureReason;
+}
+/**
+ * Cash transfer request (Remittance)
+ */
+export interface CashTransferRequest {
+    amount: string;
+    currency: string;
+    externalId?: string;
+    payee: Party;
+    originatingCountry?: string;
+    originalAmount?: string;
+    originalCurrency?: string;
+    payerMessage?: string;
+    payeeNote?: string;
+    callbackUrl?: string;
+}
+/**
+ * Cash transfer result (Remittance)
+ */
+export interface CashTransfer {
+    amount: string;
+    currency: string;
+    financialTransactionId: string;
+    externalId: string;
+    payee: Party;
+    payerMessage?: string;
+    payeeNote?: string;
+    status: TransactionStatus;
+    reason?: FailureReason;
+}
+//# sourceMappingURL=common.d.ts.map

package/lib/esm/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,aAAa,CAAC;AAElD,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,UAAU,CAAC;AAE5D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,iBAAiB,CAAC,EAAE;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,WAAW;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,UAAU,eAAe;CAC1B;AAED,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAED,oBAAY,iBAAiB;IAC3B,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AAED,oBAAY,aAAa;IACvB,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,8BAA8B,mCAAmC;IACjE,yBAAyB,8BAA8B;IACvD,gBAAgB,qBAAqB;IACrC,mBAAmB,wBAAwB;IAC3C,yBAAyB,8BAA8B;IACvD,gBAAgB,qBAAqB;IACrC,mBAAmB,wBAAwB;IAC3C,4BAA4B,iCAAiC;IAC7D,oBAAoB,yBAAyB;IAC7C,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,OAAO,YAAY;IACnB,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB"}

package/lib/esm/common.js

@@ -0,0 +1,38 @@
+export var PartyIdType;
+(function (PartyIdType) {
+    PartyIdType["MSISDN"] = "MSISDN";
+    PartyIdType["EMAIL"] = "EMAIL";
+    PartyIdType["PARTY_CODE"] = "PARTY_CODE";
+})(PartyIdType || (PartyIdType = {}));
+export var Environment;
+(function (Environment) {
+    Environment["SANDBOX"] = "sandbox";
+    Environment["PRODUCTION"] = "production";
+})(Environment || (Environment = {}));
+export var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus["SUCCESSFUL"] = "SUCCESSFUL";
+    TransactionStatus["PENDING"] = "PENDING";
+    TransactionStatus["FAILED"] = "FAILED";
+})(TransactionStatus || (TransactionStatus = {}));
+export var FailureReason;
+(function (FailureReason) {
+    FailureReason["PAYEE_NOT_FOUND"] = "PAYEE_NOT_FOUND";
+    FailureReason["PAYER_NOT_FOUND"] = "PAYER_NOT_FOUND";
+    FailureReason["NOT_ALLOWED"] = "NOT_ALLOWED";
+    FailureReason["NOT_ALLOWED_TARGET_ENVIRONMENT"] = "NOT_ALLOWED_TARGET_ENVIRONMENT";
+    FailureReason["INVALID_CALLBACK_URL_HOST"] = "INVALID_CALLBACK_URL_HOST";
+    FailureReason["INVALID_CURRENCY"] = "INVALID_CURRENCY";
+    FailureReason["SERVICE_UNAVAILABLE"] = "SERVICE_UNAVAILABLE";
+    FailureReason["INTERNAL_PROCESSING_ERROR"] = "INTERNAL_PROCESSING_ERROR";
+    FailureReason["NOT_ENOUGH_FUNDS"] = "NOT_ENOUGH_FUNDS";
+    FailureReason["PAYER_LIMIT_REACHED"] = "PAYER_LIMIT_REACHED";
+    FailureReason["PAYEE_NOT_ALLOWED_TO_RECEIVE"] = "PAYEE_NOT_ALLOWED_TO_RECEIVE";
+    FailureReason["PAYMENT_NOT_APPROVED"] = "PAYMENT_NOT_APPROVED";
+    FailureReason["RESOURCE_NOT_FOUND"] = "RESOURCE_NOT_FOUND";
+    FailureReason["APPROVAL_REJECTED"] = "APPROVAL_REJECTED";
+    FailureReason["EXPIRED"] = "EXPIRED";
+    FailureReason["TRANSACTION_CANCELED"] = "TRANSACTION_CANCELED";
+    FailureReason["RESOURCE_ALREADY_EXIST"] = "RESOURCE_ALREADY_EXIST";
+})(FailureReason || (FailureReason = {}));
+//# sourceMappingURL=common.js.map

package/lib/esm/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AAmGA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,wCAAyB,CAAA;AAC3B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,wCAAyB,CAAA;AAC3B,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,8CAAyB,CAAA;IACzB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;AACnB,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAED,MAAM,CAAN,IAAY,aAkBX;AAlBD,WAAY,aAAa;IACvB,oDAAmC,CAAA;IACnC,oDAAmC,CAAA;IACnC,4CAA2B,CAAA;IAC3B,kFAAiE,CAAA;IACjE,wEAAuD,CAAA;IACvD,sDAAqC,CAAA;IACrC,4DAA2C,CAAA;IAC3C,wEAAuD,CAAA;IACvD,sDAAqC,CAAA;IACrC,4DAA2C,CAAA;IAC3C,8EAA6D,CAAA;IAC7D,8DAA6C,CAAA;IAC7C,0DAAyC,CAAA;IACzC,wDAAuC,CAAA;IACvC,oCAAmB,CAAA;IACnB,8DAA6C,CAAA;IAC7C,kEAAiD,CAAA;AACnD,CAAC,EAlBW,aAAa,KAAb,aAAa,QAkBxB"}