如何將網站式付款應用程式改為採用「網路付款」功能,為客戶提供更優質的使用者體驗。
註冊付款應用程式後,即可接受商家發出的付款要求。本文說明如何在執行階段 (例如,顯示視窗且使用者正在與視窗互動時),從服務工作站調度付款交易。
「執行階段付款參數變更」是指一組事件,可讓商家和付款處理常式在使用者與付款處理常式互動時交換訊息。詳情請參閱使用 Service Worker 處理選用的付款資訊。
接收商家的付款要求事件
當客戶選擇使用您的網頁式付款應用程式付款,並商家叫用 PaymentRequest.show()
時,您的服務工作處理程序會收到 paymentrequest
事件。將事件監聽器新增至 Service Worker,以擷取事件並為下一個動作做好準備。
[付款處理常式] service-worker.js:
…
let payment_request_event;
let resolver;
let client;
// `self` is the global object in service worker
self.addEventListener('paymentrequest', async e => {
if (payment_request_event) {
// If there's an ongoing payment transaction, reject it.
resolver.reject();
}
// Preserve the event for future use
payment_request_event = e;
…
保留的 PaymentRequestEvent
包含這項交易的重要資訊:
資源名稱 | 說明 |
---|---|
topOrigin |
用來指出頂層網頁來源 (通常是收款人商家) 的字串。請使用這個屬性來識別商家來源。 |
paymentRequestOrigin |
指出叫用者來源的字串。當商家直接叫用 Payment Request API 時,此值可能與 topOrigin 相同,但如果 API 是由付款閘道等第三方從 iframe 中叫用,此 API 可能會有所不同。 |
paymentRequestId |
提供給 Payment Request API 的 PaymentDetailsInit 的 id 屬性。如果商家省略,瀏覽器會提供自動產生的 ID。
|
methodData |
商家在 PaymentMethodData 中提供的付款方式專屬資料。用來判斷付款交易明細。
|
total |
商家在 PaymentDetailsInit 中提供的總金額。請使用此項目建構 UI,讓客戶知道應該支付的總金額。 |
instrumentKey |
使用者選取的付款方式金鑰。這反映了您先前提供的instrumentKey ,空白字串表示使用者未指定任何付款方式。 |
開啟付款處理常式視窗,顯示網路式付款應用程式前端
收到 paymentrequest
事件時,付款應用程式可呼叫 PaymentRequestEvent.openWindow()
以開啟付款處理常式視窗。付款處理常式視窗將向客戶顯示付款應用程式介面,他們可以在該介面進行驗證、選擇運送地址和選項,以及授權付款。我們將在「處理付款前端處理付款」一節 (即將推出) 說明如何編寫前端程式碼。
將保留的承諾傳遞至 PaymentRequestEvent.respondWith()
,以便您日後可以處理付款結果。
[付款處理常式] service-worker.js:
…
self.addEventListener('paymentrequest', async e => {
…
// Retain a promise for future resolution
// Polyfill for PromiseResolver is provided below.
resolver = new PromiseResolver();
// Pass a promise that resolves when payment is done.
e.respondWith(resolver.promise);
// Open the checkout page.
try {
// Open the window and preserve the client
client = await e.openWindow(checkoutURL);
if (!client) {
// Reject if the window fails to open
throw 'Failed to open window';
}
} catch (err) {
// Reject the promise on failure
resolver.reject(err);
};
});
…
您可以使用便利的 PromiseResolver
Polyfill,任意時間解析承諾。
class PromiseResolver {
constructor() {
this.promise_ = new Promise((resolve, reject) => {
this.resolve_ = resolve;
this.reject_ = reject;
})
}
get promise() { return this.promise_ }
get resolve() { return this.resolve_ }
get reject() { return this.reject_ }
}
與前端交換資訊
付款應用程式的 Service Worker 可透過 ServiceWorkerController.postMessage()
,與付款應用程式的前端交換訊息。如要接收前端的訊息,請監聽 message
事件。
[付款處理常式] service-worker.js:
// Define a convenient `postMessage()` method
const postMessage = (type, contents = {}) => {
if (client) client.postMessage({ type, ...contents });
}
接收來自前端的可用信號
付款處理常式視窗開啟後,Service Worker 應等待來自付款應用程式前端的就緒狀態信號。Service Worker 可以在準備就緒時將重要資訊傳送至前端。
[付款處理常式] 前端:
navigator.serviceWorker.controller.postMessage({
type: 'WINDOW_IS_READY'
});
[付款處理常式] service-worker.js:
…
// Received a message from the frontend
self.addEventListener('message', async e => {
let details;
try {
switch (e.data.type) {
// `WINDOW_IS_READY` is a frontend's ready state signal
case 'WINDOW_IS_READY':
const { total } = payment_request_event;
…
將交易明細傳遞至前端
立即將付款資料傳回。在這種情況下,您只會傳送付款要求的總金額,但您可以視需要傳送更多詳細資料。
[付款處理常式] service-worker.js:
…
// Pass the payment details to the frontend
postMessage('PAYMENT_IS_READY', { total });
break;
…
[付款處理常式] 前端:
let total;
navigator.serviceWorker.addEventListener('message', async e => {
switch (e.data.type) {
case 'PAYMENT_IS_READY':
({ total } = e.data);
// Update the UI
renderHTML(total);
break;
…
傳回客戶的付款憑證
客戶授權付款時,前端可以傳送貼文給 Service Worker 繼續操作。您可以解析傳遞至 PaymentRequestEvent.respondWith()
的承諾,以便將結果傳回商家。傳遞 PaymentHandlerResponse
物件。
資源名稱 | 說明 |
---|---|
methodName |
付款時所用的付款方式 ID。 |
details |
付款方式專屬資料,提供商家處理付款所需的必要資訊。 |
[付款處理常式] 前端:
const paymentMethod = …
postMessage('PAYMENT_AUTHORIZED', {
paymentMethod, // Payment method identifier
});
[付款處理常式] service-worker.js:
…
// Received a message from the frontend
self.addEventListener('message', async e => {
let details;
try {
switch (e.data.type) {
…
case 'PAYMENT_AUTHORIZED':
// Resolve the payment request event promise
// with a payment response object
const response = {
methodName: e.data.paymentMethod,
details: { id: 'put payment credential here' },
}
resolver.resolve(response);
// Don't forget to initialize.
payment_request_event = null;
break;
…
取消付款交易
為了讓客戶取消交易,前端可以傳送貼文至服務工作站。接著,Service Worker 會使用 null
解析傳遞至 PaymentRequestEvent.respondWith()
的承諾,表示交易已取消。
[付款處理常式] 前端:
postMessage('CANCEL_PAYMENT');
[付款處理常式] service-worker.js:
…
// Received a message from the frontend
self.addEventListener('message', async e => {
let details;
try {
switch (e.data.type) {
…
case 'CANCEL_PAYMENT':
// Resolve the payment request event promise
// with null
resolver.resolve(null);
// Don't forget to initialize.
payment_request_event = null;
break;
…
程式碼範例
您在本文件中看到的所有程式碼範例都是來自以下工作範例應用程式的摘錄:
https://paymenthandler-demo.glitch.me
[付款處理常式] Service Worker
[付款處理常式] 前端
如要試用這項功能,請按照下列步驟操作:
- 前往 https://paymentrequest-demo.glitch.me/。
- 前往頁面底部。
- 按下「新增付款方式」按鈕。
- 在「付款方式 ID」欄位中輸入
https://paymenthandler-demo.glitch.me
。 - 按下欄位旁的「付款」按鈕。
後續步驟
在本文中,我們學到如何從服務工作處理程序自動化調度管理付款交易。下一步是瞭解如何將一些進階功能新增至 Service Worker。