Class: VNPay

VNPay(config)

VNPay payment gateway helper
Hàm hỗ trợ thanh toán qua VNPay

Constructor

new VNPay(config)

Instantiate a VNPay checkout helper
Khởi tạo hàm thanh toán VNPay

Parameters:
Name Type Description
config Object

check VNPay.configSchema for data type requirements
Xem VNPay.configSchema để biết yêu cầu kiểu dữ liệu
Source:
Example
import { VNPay } from 'vn-payments';

const TEST_CONFIG = VNPay.TEST_CONFIG;

const vnpayCheckout = new VNPay({
	paymentGateway: TEST_CONFIG.paymentGateway,
	merchant: TEST_CONFIG.merchant,
	secureSecret: TEST_CONFIG.secureSecret,
});

// checkoutUrl is an URL instance
const checkoutUrl = await vnpayCheckout.buildCheckoutUrl(params);

this.response.writeHead(301, { Location: checkoutUrl.href });
this.response.end();

Members

(static) checkoutSchema :SimpleSchema

The schema is based on field data requirements from VNPay's dev document
Cấu trúc dữ liệu được dựa trên các yêu cầu của tài liệu VNPay

Type:
  • SimpleSchema
Source:

(static) configSchema :SimpleSchema

VNPay configSchema

Type:
  • SimpleSchema
Source:

checkoutPayloadDefaults

Return default checkout Payloads

Lấy checkout payload mặc định cho cổng thanh toán này

Source:

Methods

(static) getReturnUrlStatus(responseCode, locale) → {string}

Get known response code status
Lấy chuỗi trạng thái từ response code đã biết

Parameters:
Name Type Default Description
responseCode *

Responde code from gateway
Mã trả về từ cổng thanh toán
locale * vn

Same locale at the buildCheckoutUrl. Note, 'vn' for Vietnamese
Cùng nơi với hàm buildCheckoutUrl. Lưu ý, 'vn' là Việt Nam
Source:
Returns:

A string contains error status converted from response code
Một chuỗi chứa trạng thái lỗi được chuyển lại từ response code

Type
string

buildCheckoutUrl(payload) → {Promise.<URL>}

Build checkoutUrl to redirect to the payment gateway
Hàm xây dựng url để redirect qua VNPay gateway, trong đó có tham số mã hóa (còn gọi là public key)

Parameters:
Name Type Description
payload VNPayCheckoutPayload

Object that contains needed data for the URL builder, refer to typeCheck object above
Đối tượng chứa các dữ liệu cần thiết để thiết lập đường dẫn.
Source:
Returns:

buildCheckoutUrl promise

Type
Promise.<URL>

validateCheckoutPayload(payload)

Validate checkout payload against specific schema. Throw ValidationErrors if invalid against checkoutSchema
Kiểm tra tính hợp lệ của dữ liệu thanh toán dựa trên một cấu trúc dữ liệu cụ thể. Hiển thị lỗi nếu không hợp lệ với checkoutSchema.

Parameters:
Name Type Description
payload VNPayCheckoutPayload
Source:

verifyReturnUrl(query) → {Promise.<VNPayReturnObject>}

Verify return query string from VNPay using enclosed vnp_SecureHash string
Hàm thực hiện xác minh tính đúng đắn của các tham số trả về từ vnpay Payment

Parameters:
Name Type Description
query Object

Query data object from GET handler (response.query)
Dữ liệu được trả về từ GET handler (response.query)
Source:
Returns:

Promise object which resolved with normalized returned data object, with additional fields like isSuccess.
Promise khi hoàn thành sẽ trả về object data từ cổng thanh toán, được chuẩn hóa tên theo camelCase và đính kèm thuộc tính isSuccess

Type
Promise.<VNPayReturnObject>