mtn-momo
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    MTN MoMo API NodeJS Client

    Power your apps with our MTN MoMo API

    Join our active, engaged community:
    Website | Spectrum

    Build Status NPM Version Installs Known Vulnerabilities Coverage Status Join the community on Spectrum

    Usage

    Installation

    Add the library to your project

    npm install --save mtn-momo

    Sandbox Credentials

    Next, we need to get the User ID and User Secret and to do this we shall need to use the Primary Key for the Product to which we are subscribed, as well as specify a host. We run the momo-sandbox as below.

    ## Within a project
    npx momo-sandbox --host example.com --primary-key 23e2r2er2342blahblah

    If all goes well, it will print the credentials on the terminal;

    Momo Sandbox Credentials {
      "userSecret": "b2e23bf4e3984a16a55dbfc2d45f66b0",
      "userId": "8ecc7cf3-0db8-4013-9c7b-da4894460041"
    }

    These are the credentials we shall use for the sandbox environment. In production, these credentials are provided for you on the MTN OVA management dashboard after KYC requirements are met.

    Configuration

    Before we can fully utilize the library, we need to specify global configurations. The global configuration must contain the following:

    • baseUrl: An optional base url to the MTN Momo API. By default the staging base url will be used
    • environment: Optional enviroment, either "sandbox" or "production". Default is 'sandbox'
    • callbackHost: The domain where you webhooks urls are hosted. This is mandatory.

    As an example, you might configure the library like this:

    const momo = require("mtn-momo");
    
    const { Collections, Disbursements } = momo.create({
      callbackHost: process.env.CALLBACK_HOST
    });

    Collections

    The collections client can be created with the following paramaters. Note that the userId and userSecret for production are provided on the MTN OVA dashboard;

    • primaryKey: Primary Key for the Collections product.
    • userId: For sandbox, use the one generated with the momo-sandbox command.
    • userSecret: For sandbox, use the one generated with the momo-sandbox command.

    You can create a collections client with the following

    const collections = Collections({
      userSecret: process.env.USER_SECRET,
      userId: process.env.USER_ID,
      primaryKey: process.env.PRIMARY_KEY
    });

    Methods

    1. requestToPay(request: PaymentRequest): Promise<string>: This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction is executed once the payer has authorized the payment. The transaction will be in status PENDING until it is authorized or declined by the payer or it is timed out by the system. Status of the transaction can be validated by using getTransaction

    2. getTransaction(transactionId: string): Promise<Payment>: Retrieve transaction information using the transactionId returned by requestToPay. You can invoke it at intervals until the 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 for the various errors that can be thrown

    3. getBalance(): Promise<Balance>: Get the balance of the account.

    4. isPayerActive(id: string, type: PartyIdType = "MSISDN"): Promise<string>: check if an account holder is registered and active in the system.

    Sample Code

    const momo = require("mtn-momo");
    
    const { Collections } = momo.create({
      callbackHost: process.env.CALLBACK_HOST
    });
    
    const collections = Collections({
      userSecret: process.env.COLLECTIONS_USER_SECRET,
      userId: process.env.COLLECTIONS_USER_ID,
      primaryKey: process.env.COLLECTIONS_PRIMARY_KEY
    });
    
    // Request to pay
    collections
      .requestToPay({
        amount: "50",
        currency: "EUR",
        externalId: "123456",
        payer: {
          partyIdType: "MSISDN",
          partyId: "256774290781"
        },
        payerMessage: "testing",
        payeeNote: "hello"
      })
      .then(transactionId => {
        console.log({ transactionId });
    
        // Get transaction status
        return collections.getTransaction(transactionId);
      })
      .then(transaction => {
        console.log({ transaction });
    
        // Get account balance
        return collections.getBalance();
      })
      .then(accountBalance => console.log({ accountBalance }))
      .catch(error => {
        console.log(error);
      });

    Disbursement

    The disbursements client can be created with the following paramaters. Note that the userId and userSecret for production are provided on the MTN OVA dashboard;

    • primaryKey: Primary Key for the Disbursements product.
    • userId: For sandbox, use the one generated with the momo-sandbox command.
    • userSecret: For sandbox, use the one generated with the momo-sandbox command.

    You can create a disbursements client with the following

    const disbursements = Disbursements({
      userSecret: process.env.DISBURSEMENTS_USER_SECRET,
      userId: process.env.DISBURSEMENTS_USER_ID,
      primaryKey: process.env.DISBURSEMENTS_PRIMARY_KEY
    });

    Methods

    1. transfer(request: TransferRequest): Promise<string>

    Used to transfer an amount from the owner’s account to a payee account. It returns a transaction id which can use to check the transaction status with the getTransaction function

    1. getTransaction(transactionId: string): Promise<Transfer>: Retrieve transaction information using the transactionId returned by transfer. You can invoke it at intervals until the 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 for the various errors that can be thrown

    2. getBalance(): Promise<Balance>: Get your account balance.

    3. isPayerActive(id: string, type: PartyIdType = "MSISDN"): Promise<boolean>: This method is used to check if an account holder is registered and active in the system.

    Sample Code

    const momo = require("mtn-momo");
    
    // initialise momo library
    const { Disbursements } = momo.create({
      callbackHost: process.env.CALLBACK_HOST
    });
    
    // initialise disbursements
    const disbursements = Disbursements({
      userSecret: process.env.DISBURSEMENTS_USER_SECRET,
      userId: process.env.DISBURSEMENTS_USER_ID,
      primaryKey: process.env.DISBURSEMENTS_PRIMARY_KEY
    });
    
    // Transfer
    disbursements
      .transfer({
        amount: "100",
        currency: "EUR",
        externalId: "947354",
        payee: {
          partyIdType: "MSISDN",
          partyId: "+256776564739"
        },
        payerMessage: "testing",
        payeeNote: "hello",
        callbackUrl: "https://75f59b50.ngrok.io"
      })
      .then(transactionId => {
        console.log({ transactionId });
    
        // Get transaction status
        return disbursements.getTransaction(transactionId);
      })
      .then(transaction => {
        console.log({ transaction });
    
        // Get account balance
        return disbursements.getBalance();
      })
      .then(accountBalance => console.log({ accountBalance }))
      .catch(error => {
        console.log(error);
      });

    Install

    npm i mtn-momo

    DownloadsWeekly Downloads

    91

    Version

    2.0.0

    License

    ISC

    Unpacked Size

    102 kB

    Total Files

    43

    Last publish

    Collaborators

    • ernst-okot
    • raybesiga
    • sparkplugtech