Payoo-payment-gateway NPM

API Payoo Payment Gateway

The plugin will make it easier to integrate Payoo payments. Pay easy ATM payment method

Process flow

Flow

Installation

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

npm i payoo-payment-gateway

Usage

import { PayooPayment } from 'payoo-payment-gateway';


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

/* constructor: username, shopId, shopTitle, checksumKey, 
endpointCheckout, shopDomain, endpointRefund, apiUsername, 
apiUserpassword, apiSignature => provided by Payoo*/
/*  endpointCheckout:
      sandbox:  https://newsandbox.payoo.com.vn
      live:     https://www.payoo.vn
    endpointRefund:
      sandbox:  https://biz-sb.payoo.vn/BusinessRestAPI.svc
      live:     https://biz.payoo.vn/BusinessRestAPI.svc */

class PayooPaymentService {
    constructor(username, shopId, shopTitle, checksumKey, endpointCheckout, shopDomain, endpointRefund, apiUsername, apiUserpassword, apiSignature) {
      this.payooPayment = new PayooPayment({
        username,
        shopId,
        shopTitle,
        checksumKey,
        endpointCheckout,
        shopDomain,
        endpointRefund,
        apiUsername,
        apiUserpassword,
        apiSignature,
      })
    };

/* The payment method payUrl is returned  */
  async createPayment({
    orderId,
    orderNumber,
    amount,
    returnUrl = 'https://your-website.com',
  }) {
    try {
      const result = await this.payooPayment.createOrderRequest({
        orderId,
        orderNumber,
        amount,
        returnUrl,
        notifyUrl: HOST_WEBHOOK,
      });
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }
  
/* Proceed the refund payment */
  async refundPayment({ OrderNo, PurchaseDate, Money, Description }) {
    try {
      const result = await this.payooPayment.refundPayment({
        OrderNo,
        Money,
        Description,
        PurchaseDate,
      });
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }

/* The function for verify webhook request and payment */
/* Get IP in headers 'x-forwarded-for' */
/* Get XML from body.NotifyData */
  verifyNotifyData({ ip, xml }) {
    try {
      const result = this.payooPayment.verifyNotifyData({ ip, xml });
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }

  verifyPayment({ status, session, order_no, checksum, totalAmount, paymentFee }){
    try {
      const result = this.payooPayment.verifyPayment({status, session, order_no, checksum, totalAmount, paymentFee })
      return result;
    } catch (error) {
      console.error(error)
      throw error;
    }
  }
}