串接流程(必讀)
一、串接方式說明
我們提供兩種串接方式,分別為導轉式和內嵌式,為不同需求的特店都提供了解決方案。
導轉式:此方式透過 API 提供金流付款頁連結給特店,由特店的結帳頁進行導轉付款。優點在於串接方便快捷,省心省力,適用於更關注銷售環節的特店。
內嵌式:此方式透過 SDK + API 提供金流服務給特店,讓特店在其結帳頁內嵌金流 SDK,讓顧客可以直接進行在結帳頁進行付款。此方式支援信用卡的進階服務,如綁定卡片、定期交易等,適用於關注全流程的特店。
功能概覽
功能類別 | 功能名稱 | 功能描述 |
---|---|---|
結帳交易 | 建立結帳交易 | 無需串接SDK,僅通過此API協助特店/平台建立付款交易 |
查詢 | 通過此API主動查詢結帳交易的資訊 | |
付款交易 | 建立付款交易 | 通過此API進行所有付款方式的交易建立 |
查詢 | 通過此API主動查詢付款交易的資訊 | |
請款 | 通過此API對信用卡付款方式的授權交易進行請款動作,扣除授權鎖定的金額額度 | |
取消授權 | 通過此API對信用卡付款方式的授權交易進行取消授權動作,釋放授權鎖定的金額額度。於請款前方可進行取消授權 | |
退款 | 通過此API對所有付款方式的成功交易進行退款,退還款項給顧客。於請款後方可進行退款 | |
綁卡/快捷/定期交易 | 會員 | 通過會員相關API進行會員的增/刪/改/查動作 |
付款工具 | 通過付款工具相關API進行會員下的付款工具刪/改/查動作 | |
平台Connect | 平台Connect | 通過此API,平台可與已註冊SHOPLINE Payments的特店進行授權,特店授權通過後,平台方可處理特店的交易/請款/取消授權/退款/會員/付款工具 |
二、串接步驟介紹
為了確保串接效率,保障串接質量,特店串接前請務必仔細閱讀此串接流程,依照規格所述流程串接。
串接流程主要分為以下幾個步驟:
1. 特店申請
- 特店與 SHOPLINE Payments 業務窗口聯繫,進行網站特店註冊,同時填寫申請資訊,提交審核
- 審核通過後,特店向 SHOPLINE Payments 串接窗口申請,產生以下正式環境技術串接金鑰
金鑰類型 | 金鑰用途 |
---|---|
apiKey | 用於 Server-api 串接認證 |
clientKey | 用於 SDK 串接認證 |
signKey | 用於 Event 通知串接認證 |
2. 技術串接及申請
SHOPLINE Payments 提供兩種串接方式,分別為導轉式和內嵌式,會先請負責串接的技術人員確認選擇需要的串接方式,並按對應的方式進行串接;
導轉式
主要分為以下重點步驟:
內嵌式
主要分為以下重點步驟:
在內嵌式串接方式下,SHOPLINE Payments 還提供以下收款業務場景串接:
- 一般收款,支援信用卡、信用卡分期、ATM銀行轉帳、街口支付、中租 zingla 銀角零卡分期、LINE Pay等收款功能;一般付款串接
- 綁卡/快捷/定期收款,支援特店提供給顧客綁定常用信用卡進行快速、定期扣款等收款功能;綁卡/快捷/定期付款串接
3.沙盒環境串接
特店技術人員依據串接規格完成串接後,可在 SHOPLINE Payments 沙盒環境進行聯調驗證
- 串接前,可聯絡 SHOPLINE Payments 業務窗口建立串接群組,以便溝通與解決串接問題
- 沙盒環境整合資源可參照:沙盒環境串接資源
- 沙盒環境需完成付款、退款、Event 通知等功能串接驗證,綁卡/快捷場景需完成會員及付款工具功能驗證
- 沙盒環境驗證完成後,進行正式環境串接
4. 正式環境驗證
特店技術人員在完成沙盒環境串接驗證後,可安排進行正式環境串接,正式環境串接後,即可使用 SHOPLINE Payments 進行收款
- 設定 apiKey, clientKey, signKey, 此為申請階段網站後台產生的金鑰
- webhook 地址设置: 通知[Event]
- 正式環境驗證付款、退款、Event 通知等功能