Constructor
new OnePayInternational(config)
Instantiate a OnePayInternational checkout helper
Khởi tạo hàm thanh toán OnePayInternational
Parameters:
Name | Type | Description |
---|---|---|
config |
Object | check OnePay.configSchema for data type requirements. |
- Source:
Example
import { OnePayInternational } from 'vn-payments';
const TEST_CONFIG = OnePayDomestic.TEST_CONFIG;
const onepayCheckout = new OnePayInternational({
accessCode: TEST_CONFIG.accessCode,
merchant: TEST_CONFIG.merchant,
paymentGateway: TEST_CONFIG.paymentGateway,
secureSecret: TEST_CONFIG.secureSecret,
});
// checkoutUrl is an URL instance
const checkoutUrl = await onepayCheckout.buildCheckoutUrl(params);
this.response.writeHead(301, { Location: checkoutUrl.href });
this.response.end();
Extends
Members
(static) TEST_CONFIG
OnePayInternational test config
Cấu hình dùng thử OnePayInternational
- Source:
checkoutPayloadDefaults
Return default checkout Payloads
Lấy checkout payload mặc định cho cổng thanh toán này
- Overrides:
- Source:
Methods
(static) getReturnUrlStatus(responseCode, locale) → {string}
Parameters:
Name | Type | Default | Description |
---|---|---|---|
responseCode |
* | Responde code from gateway |
|
locale |
* | vn | Same locale at the buildCheckoutUrl. Note, 'vn' for Vietnamese |
- 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 checkout URL to redirect to the payment gateway.
Hàm xây dựng url để redirect qua OnePay gateway, trong đó có tham số mã hóa (còn gọi là public key).
Parameters:
Name | Type | Description |
---|---|---|
payload |
OnePayCheckoutPayload | Object that contains needed data for the URL builder, refer to typeCheck object above. |
- Inherited From:
- Source:
Returns:
buildCheckoutUrl promise
- Type
- Promise.<URL>
validateCheckoutPayload(payload)
Validate checkout payload against specific schema. Throw ValidationErrors if invalid against checkoutSchema
Build the schema in subclass.
Kiểm tra tính hợp lệ của dữ liệu thanh toán dựa trên schema đã được đồng bộ với tài liệu của nhà cung cấp.
Hiển thị lỗi nếu không hợp lệ với checkoutSchema.
Schema sẽ được tạo trong class con.
Parameters:
Name | Type | Description |
---|---|---|
payload |
OnePayCheckoutPayload |
- Overrides:
- Source:
verifyReturnUrl(query) → {Promise.<OnePayInternationalReturnObject>}
Verify return query string from OnePay using enclosed vpc_SecureHash string
Hàm thực hiện xác minh tính đúng đắn của các tham số trả về từ onepay Payment
Parameters:
Name | Type | Description |
---|---|---|
query |
* |
- Overrides:
- 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.<OnePayInternationalReturnObject>