momo-payment-gateway

API MoMo Payment Gateway

The plugin will make it easier to integrate Momo Wallet payments via QR code.

Process flow

Installation

The first, Momo partner must be successfully registered. Use the package manager npm to install.

npm i momo-payment-gateway

Usage

import { MomoPayment } from 'momo-payment-gateway';


/* HOST_WEBHOOK => Partner API. Used by MoMo to submit payment results by IPN method (server-to-server) method */
const HOST_WEBHOOK = process.env.HOST_WEBHOOK;

/* constructor: partnerCode, accessKey, secretKey ,apiEndpoint=> provided by Momo*/
class MomoPaymentService {
  constructor( partnerCode, accessKey, secretKey, endpoint) {
    this.momoPayment = new MomoPayment({
      partnerCode,
      accessKey,
      secretKey,
      apiEndpoint,
    });
  }

/* The payment method payUrl is returned  */
  async createPayment({
    orderId,
    amount,
    orderInfo = 'Your message',
    returnUrl = 'https://your-website.com',
  }) {
    try {
      if (!orderId || !amount || !message || !orderInfo) {
        throw new Error('invalid input');
      }
      const result = await this.momoPayment.createPayment({
        requestId: `ID-${orderId}-${Math.round(Date.now() / 1000)}`,
        orderId: `${orderId}-${Math.round(Date.now() / 1000)}`,
        amount,
        orderInfo,
        returnUrl,
        ipnUrl: HOST_WEBHOOK,
      });
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }
  
/* Proceed the refund payment */
  async refundPayment({ requestId, orderId, amount, transId }) {
    try {
      if (!orderId || !amount || !transId) {
        throw new Error('invalid input');
      }
      const result = await this.momoPayment.refundPayment({
        requestId,
        orderId,
        amount,
        transId,
      });
      return result.data;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }

/* The function for verify webhook request and payment */
  verifySignature({
    signature,
    requestId,
    orderId,
    amount,
    orderInfo,
    orderType,
    transId,
    message,
    localMessage,
    responseTime,
    errorCode,
    payType,
  }) {
    try {
      const result = this.momoPayment.verifySignature({
        signature,
        requestId,
        orderId,
        amount,
        orderInfo,
        orderType,
        transId,
        message,
        localMessage,
        responseTime,
        errorCode,
        payType,
      });
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }
}

Contributing

Pull requests are welcome

Important

Mail: [e-mail] Skype: [e-mail] Documentation: https://developers.momo.vn/

License

MIT