JSDoc: Class: SohaPay

Constructor

new SohaPay(config)

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

Parameters:

Name	Type	Description
`config`	Object	check SohaPay.configSchema for data type requirements Xem SohaPay.configSchema để biết yêu cầu kiểu dữ liệu

Source:

sohapay/SohaPay.js, line 36

Example

import { SohaPay } from 'vn-payments';

const TEST_CONFIG = SohaPay.TEST_CONFIG;

const sohapayCheckout = new SohaPay({
	paymentGateway: TEST_CONFIG.paymentGateway,
	merchant: TEST_CONFIG.merchant,
 receiverEmail: TEST_CONFIG.receiverEmail,
	secureSecret: TEST_CONFIG.secureSecret,
});

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

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

Members

(static) checkoutSchema :SimpleSchema

SohaPay checkoutSchema

Type:

SimpleSchema

Source:

sohapay/SohaPay.js, line 286

(static) configSchema :SimpleSchema

SohaPay configSchema

Type:

SimpleSchema

Source:

sohapay/SohaPay.js, line 244

(static) TEST_CONFIG

SohaPay test configs
Cấu hình dùng thử SohaPay

Source:

sohapay/SohaPay.js, line 322

checkoutPayloadDefaults

Return default checkout Payloads

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

Source:

sohapay/SohaPay.js, line 136

Methods

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

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

Parameters:

Name	Type	Description
`payload`	SohaPayCheckoutPayload	Object that contains needed data for the URL builder Đối tượng chứa các dữ liệu cần thiết để thiết lập đường dẫn.

Source:

sohapay/SohaPay.js, line 57

Returns:

The URL object used to redirect
Đối tượng URL dùng để chuyển trang qua cổng thanh toán

Type: Promise.<URL>

validateCheckoutPayload(payload)

Validate checkout payload against checkoutSchema. Throw ValidationErrors if invalid.
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ệ.

Parameters:

Name	Type	Description
`payload`	SohaPayCheckoutPayload

Source:

sohapay/SohaPay.js, line 126

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

Verify return query string from SohaPay using enclosed secureCode string
Hàm thực hiện xác minh tính đúng đắn của các tham số trả về từ SohaPay 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:

sohapay/SohaPay.js, line 178

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.<SohaPayReturnObject>