定期定額是「消費者同意一次,之後由應援依週期自動扣款」。只支援信用卡,扣款週期以月為單位。
三種建立方式
Section titled “三種建立方式”| 建立定期定額 | 建立預約定期定額 | 用 token 建立定期定額 | |
|---|---|---|---|
| 消費者要做的事 | 在結帳頁付第一期 | 在結帳頁綁卡(首期是今天時同時付款) | 不用,之前已經綁卡 |
| 第一期何時扣 | 消費者付款當下 | startDate:今天就是付款當下,未來日期就在當天扣 |
不帶 startDate 就在呼叫 API 當下;帶未來日期就在當天扣 |
| 扣款間隔 | 固定每 1 個月 | 1 到 12 個月(paymentInterval) |
1 到 12 個月 |
startDate |
不支援 | 今天到 12 個月內 | 必須晚於今天,12 個月內 |
| 回應 | id、transactionHid |
id、subscriptionHid |
subscriptionId、transactionId、authCode |
| 適合 | 最簡單的月費 | 季繳、年繳、下個月才開始扣 | 已經有存卡的會員 |
numberOfPeriods是總期數,最少 2 期;不帶就是不限期,直到取消。- 每期金額固定,就是建立時的
amount。要改金額,請取消後重新建立。 - 定期定額編號是
S開頭,查詢與取消都用它。用「建立定期定額」時,第一期付款成功後,付款通知與查詢結果的subscriptionId就是這個編號。
每期什麼時候扣款
Section titled “每期什麼時候扣款”- 應援每天台北時間上午 9 點執行扣款。
- 下一期日期 = 上一期實際扣款的日期 + 間隔月數。
- 每次扣款前 3 天,應援會寄扣款提醒信給消費者(有 Email 時)。
- 每一期的結果都會送出
purpose為charge、action為subscription的付款通知。
建議開啟重扣:CRM「總設定」→「開發者」→「定期交易重試機制(Beta)」→「定期購買」。開啟後:
- 失敗後最多重扣 2 次,每次間隔約 24 小時。
- 發卡銀行明確拒絕(例如卡片停用)或付款結果不明時,不會重扣。
- 重扣中的狀態是
retryScheduled;重扣成功就回到ongoing,用完仍失敗就變成error。 - 每一次重扣都會送付款通知,
isRetry為true。
定期定額停止後,請聯絡消費者重新訂閱,例如換一張卡走一次建立定期定額。
呼叫 PUT /subscriptions/{subscriptionHid},或在 CRM「定期購買」按「終止定期購買」。
- 只接受
S開頭的定期定額編號。 - 請一定要送 body(至少
merchantId),沒送會回 500。 - 可以取消的狀態:
scheduled、ongoing、retryScheduled。 - 取消後不能恢復。
消費者提出取消,就應該立即取消,不需要等消費者再次確認;取消之後才扣到的款項,請退款給消費者。
- 單筆:
GET /subscriptions/{id},可以用S編號或內部 id。 - 某一期的交易:付款通知裡的
id,或用訂單編號查詢列出同一個orderId的所有期數。 - 狀態說明見 Subscription 物件。
3D 驗證與綁卡
Section titled “3D 驗證與綁卡”use3d: true時,消費者在結帳頁走 3D 驗證。應援可能依收單設定強制 3D。- 部分收單機構不支援 0 元驗證,綁卡時會先授權新台幣 1 元再立即退回,結帳頁會事先告知消費者。
- 首期日在未來時,消費者在結帳頁只綁卡,卡片是否可用要到首期扣款時才知道。
消費者要換卡
Section titled “消費者要換卡”Payment API 目前沒有公開的換卡流程。常見做法:取消舊的定期定額,請消費者重新走一次結帳建立新的。
| 時機 | purpose |
|---|---|
| 「建立定期定額」第一期付款 | charge(action: subscription) |
| 「建立預約定期定額」結帳完成 | schedule_subscription |
| 之後每一期(含重扣) | charge(action: subscription) |
| 「用 token 建立定期定額」的第一期 | 不送,以 API 回應為準 |
| 取消、重扣排定或用完 | subscription_cancelled、subscription_retry,需請應援開啟 |
欄位見付款通知內容。
導覽助手暫停服務中。請使用右上角的搜尋,或聯絡客服。
我可以幫你選擇收款方式、回答 API 串接與 CRM 操作問題,並附上文件出處。
