WooCommerce Subscription 定期定額金流串接

有別於一般金流的一次性付款,WooCommerce Subscription 訂閱外掛可以實現週期性付款的功能,也就是以月或年為單位,時間到自動向消費者進行請款,像是 SaaS 服務多半是用定期定額付費,就不用讓消費者重新刷卡。

在 WooCommerce 生態圈中要實現定期定額的功能,最多人使用的是 WooCommerce Subscription 訂閱外掛,目前台灣廠商開發的定期定額金流外掛也多半是支援它,因此該文會以此外掛為主,逐步說明串接定期定額金流的流程與注意事項。

一、定期定額金流類型

根據金流商的不同,在處理定期定額付款有兩種方式:

1. 自動定期扣款

指的是金流商可以接受定期扣款參數,像是可扣款頻率、扣款日期、扣款金額,網站這邊只要在結帳時把相關參數傳送過去後,之後的扣款都會由金流商「自動」處理,網站這邊只要關心當顧客不續訂時,將金流商的自動扣款功能透過 API 來停用即可。

以串接上的體驗來說,該類型應該會比較好處理,只要在第一次結帳跟不續訂時呼叫金流商的 API 即可,中間的扣款流程網站這邊完全不需要擔心。

2. 手動呼叫扣款

是指當顧客第一次完成結帳後,我們會從金流商那邊取得一串加密過的字串,然後後續扣款就會使用這個字串來進行請款,相較於原生支援,該類型的金流因為要在時間到時「手動」呼叫金流商 API 做請款的動作,因此整個過程會比較繁瑣,除了要處理排程的扣款,還要擔心 API 失敗的後續處理。

剛好這次專案就是要處理這類型的定期定額金流,因此以下說明皆會以手動呼叫扣款的開發流程來進行說明。

二、定期定額扣款流程

分為以下幾個大步驟:

  1. 顧客在結帳頁輸入卡號送出
  2. 金流商回傳付款加密字串
  3. 網站資料庫紀錄加密字串而非真實卡號
  4. 結帳完成後產生一張一般訂單與訂閱訂單
  5. 使用 WooCommerce Subscription 排程 woocommerce_scheduled_subscription_payment進行定期扣款
  6. 排程觸發後產生新的一般訂單,並與原始的訂閱訂單做關聯
  7. 如果排程執行扣款成功,會自動產生下一期扣款的排程,原始的訂閱訂單狀態會「已啟用」
  8. 如果排程執行扣款失敗,新的一般訂單會顯示失敗,原始的訂閱訂單會狀態會顯示「保留」

這邊要注意的是排程的勾點名稱在官方文件上是寫 scheduled_subscription_payment_{gateway_id},但實際上要用這個 woocommerce_scheduled_subscription_payment_{gateway_id} 帶有 WooCommerce 前綴的勾點才是正確的。

另外該專案還要滿足以下條件:

  • 需要紀錄卡號(加密字串),讓顧客下次結帳可以選擇不同的信用卡
  • 讓顧客可以在我的帳號頁自行新增、刪除與設定預設扣款信用卡
  • 排程扣款失敗時,可以讓管理員手動點擊付款
  • 支援有試用期的定期定額商品(初始訂單為零元)

接下來針對以上流程與專案需求說明開發上的一些注意事項。

三、結帳頁信用卡表單

由於我們必須使用顧客的真實卡號來取得金流商回傳的付款加密字串,在結帳頁中需要提供信用卡卡號的輸入介面,如下圖:

在我開發的第一個版本中,因為沒有注意到 WooCommerce 有內建的輸入介面,所以就直接在金流類別中的 payment_field() 直接手刻信用卡表單,後來是因為要整合更換卡號功能,也就是下圖中的頁面,最後還是只能全部改寫成內建的方法:

1. 信用卡表單

要在 Payment Gateway 類別裡面使用 WooCommerce 內建的信用卡表單,首先需要繼承的類別是不是 WC_Payment_Gateway 而是 WC_Payment_Gateway_CC,後者一樣是繼承前者而來,只是多了 Credit Card (CC) 信用卡相關功能,該類別有一個 form() 方法,定義了信用卡表單的 HTML。

接著在設定 support 屬性的地方加入 tokenization 即可,如果同時要支援訂閱的話,也是在這邊加入以下參數:

<?php
$this->supports = array(
	'products',
	'subscriptions', // 以下為訂閱外關相關參數
	'subscription_cancellation',
	'subscription_suspension',
	'subscription_reactivation',
	'subscription_amount_changes',
	'subscription_date_changes',
	'subscription_payment_method_change',
	'subscription_payment_method_change_customer',
	'subscription_payment_method_change_admin',
	'multiple_subscriptions',
	'tokenization', // 判斷為 Token 付款,會自動加入信用卡表單
);

這邊有一個需要注意的地方是 WC_Payment_Gateway_CC 的信用卡表單 input 是不帶有 name 屬性,這代表我們無法在 process_payment() 中用 $_POST[“card-number”] 來取得真實的卡號,根據官方的回覆說這是為了避免開發者將卡號透過 HTTP 進行傳輸。

比較好的作法是需要傳輸的資料都是加密後的結果,避免中間被攔截而造成卡號外洩,可能的作法是金流商提供前端套件將卡號做加密後再行傳送,但該專案串接的金流商並未提供該機制,還是只能將信用卡卡號作為參數來進行傳送。

為了實現這一點,我在我的金流類別中複寫了 form() 方法,基本架構一模一樣,只是加入了 input 的 name 屬性,讓我可以從後端拿到信用卡的相關資料:

2.新增信用卡

要讓顧客可以在前台自行新增付款方式,在我們的金流類別中需要實作 add_payment_method() 方法,然後從我們自己加入 name 的 form() 裡面拿到信用卡資料,再去做一次結帳資料的傳送,最後返回一個跟 process_payment() 有點類似的陣列,差別在於是重新導向回付款方式頁:

<?php

public function add_payment_method(){
	
    // 處理新增付款方式

	return array(
		'result' => 'success',
		'redirect' => wc_get_endpoint_url( 'payment-methods' ),
	)
}

由於新增信用卡並非是結帳流程,而我們必須要透過金流商的付款 API 才能取得付款加密字串,因此這邊要額外處理付款參數的傳送,特別是訂單金額的部分,新增付款方式不會有訂單金額,但金流商 API 零元訂單是不允許的,所以需要先刷 10 元然後再透過退款 API 來退款。

這邊我遇到的狀況是在付款 API 呼叫完的當下立即執行退款,結果一直遇到退款發生錯誤,原因出在付款 API 的流程還沒走完,退款 API 會找不到要退哪一筆單,理論上要多接一個訂單查詢 API 來確認這件事,但實務上退款這件事應該不用「即時」完成,因此我的解決辦法是付款 API 打完後,安排一個一分鐘後的排程來進行退款 API 的呼叫,就能避免上述問題的發生。

四、付款加密字串處理

WooCommerce 提供一個 WC_Payment_Token_CC 的類別來處理 Token,也就是付款用的加密字串,在資料庫中有兩張表是來紀錄 Token 資訊的,分別是 wp_woocommerce_payment_tokenswp_woocommerce_payment_tokenmeta,而該類別也提供方法讓開發者可以儲存 Token。

無效或遺漏 Payment token

我設計的方法是在金流商回傳 Token、卡號末四碼後來建立屬於該顧客的 Token 資訊,寫入方法很簡單,透過以下程式碼即可:

<?php

$token = new \WC_Payment_Token_CC();
$token->set_token( $card_hash );
$token->set_gateway_id( $method );
$token->set_card_type( 'visa' );
$token->set_last4( $card_4no );
$token->set_expiry_month( $card_expiry_month );
$token->set_expiry_year( $card_expiry_year );
$token->set_user_id( $order->get_customer_id() );
$token->save();

然後在結帳的時候如果顧客選擇已經儲存的卡號,就可以使用 WC_Payment_Tokens 類別的 get() 方法來取得 Token 物件,然後再用 get_token() 方法找到付款加密字串:

<?php

$token = \WC_Payment_Tokens::get( $order->get_meta( '_payuni_token_id' ) );
$token->get_token(); // 取得加密付款字串

這邊我踩到一個卡關卡超久的雷:在結帳的時候按下送出,一直出現「無效或遺漏 Payment token」的錯誤訊息,爬了原始碼跟改變寫法一直無法排除,後來才發現原來是在寫入 Token 的 $token->set_expiry_year() 方法年份格式錯誤。

我一直以為信用卡的年份都是兩位數,像是 2023 寫 23 就好,但是這邊必須要四位數也就是 2023,不然就會發生錯誤,另外補充 Payment Token 的文件不是在 WooCommerce 官網上而是在 Github:https://github.com/woocommerce/woocommerce/wiki/Payment-Token-API#adding-payment-token-api-support-to-your-gateway

小結

跟一般金流比起來,定期定額需要考慮到的情境比較多,特別是在定期扣款以及儲存 Token 這一塊,需要反覆測試以及小心不要把不該儲存的資訊儲存下來,但整體的基礎架構還是可以從一般的金流類別來加以擴充。為避免篇幅太長,下次有機會我再把具體的程式碼整理出來~

目錄

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *

這個網站採用 Akismet 服務減少垃圾留言。進一步了解 Akismet 如何處理網站訪客的留言資料

賴俊吾 / Oberon Lai
賴俊吾 / Oberon Lai

現為全職 WordPress 工程師,網站開發經歷 11 年,專攻前端工程與 WordPress 佈景主題、外掛客製化開發

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!

專注於分享 WordPress 開發、接案技巧、專案管理等自由工作者必備知識與心得

© 2024 想點創意科技有限公司

想點創意科技有限公司 | 統一編號 90516823
Designed by Hend Design | 隱私權政策

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!