Skip to main content

Installation

tip

If you're using NestJS, install nestjs-vnpay - a ready-to-use wrapper for NestJS.

Installation with Package Managers​

NPM​

$ npm install vnpay

Yarn​

$ yarn add vnpay

PNPM​

$ pnpm install vnpay

Usage​

Import the Library​

import { VNPay } from 'vnpay';

Initialize the Instance​

import { VNPay, ignoreLogger } from 'vnpay';

const vnpay = new VNPay({
    tmnCode: 'YOUR_TMNCODE',
    secureSecret: 'YOUR_SECURE_SECRET',
    vnpayHost: 'https://sandbox.vnpayment.vn',
    testMode: true, // optional, overrides vnpayHost to sandbox if true
    hashAlgorithm: 'SHA512', // optional

    /**
     * Enable/disable logging
     * If enableLog is false, loggerFn will not be used in any method
     */
    enableLog: true, // optional

    /**
     * `loggerFn` will be called to write logs when enableLog is true
     * By default, loggerFn will write logs to the console
     * If you want to write logs elsewhere, you can provide a custom function
     *
     * `ignoreLogger` is a function that does nothing
     */
    loggerFn: ignoreLogger, // optional

    /**
     * Customize VNPay API endpoints
     * Usually doesn't need to be changed unless:
     * - VNPay updates their paths
     * - There are differences between sandbox and production environments
     */
    endpoints: {
        paymentEndpoint: 'paymentv2/vpcpay.html',
        queryDrRefundEndpoint: 'merchant_webapi/api/transaction',
        getBankListEndpoint: 'qrpayauth/api/merchant/get_bank_list',
    }, // optional
});