Skip to main content

串接流程(必讀)

一、串接方式說明

為了保證特店高轉化率,高安全性,我們在交易流程中採用了 Web JS SDK + API 的方案。並在此基礎上整合了所有付款方式流程,讓您一次串接,後續無憂; 因為 SHOPLINE Payments 支援 Web JS SDK,因此可以支援內嵌 SDK 做法的 PC 網頁或行動裝置網頁。

支援场景

功能概覽

功能類別功能名稱功能描述
一般交易建立交易單通過此API進行所有付款方式的交易單建立
請款通過此API對信用卡付款方式的授權交易進行請款動作,扣除授權鎖定的金額額度
取消授權通過此API對信用卡付款方式的授權交易進行取消授權動作,釋放授權鎖定的金額額度。於請款前方可進行取消授權
退款通過此API對所有付款方式的成功交易進行退款,退還款項給顧客。於請款後方可進行退款
綁卡/快捷/定期交易會員通過會員相關API進行會員的增/刪/改/查動作
付款工具通過付款工具相關API進行會員下的付款工具刪/改/查動作
平台Connect平台Connect通過此API,平台可與已註冊SHOPLINE Payments的特店進行授權,特店授權通過後,平台方可處理特店的交易/請款/取消授權/退款/會員/付款工具

二、串接步驟介紹

為了確保串接效率,保障串接質量,特店串接前請務必仔細閱讀此串接流程,依照規格所述流程串接。

串接流程主要分為以下幾個步驟:

  1. 特店/平台進申請
  2. 技術串接及申請
  3. 沙盒環境聯合測試
  4. 正式環境驗證

1. 特店申請

  1. 特店與 SHOPLINE Payments 業務窗口聯繫,進行網站特店註冊,同時填寫申請資訊,提交審核
  2. 審核通過後,特店向 SHOPLINE Payments 串接窗口申請,產生以下正式環境技術串接金鑰
金鑰類型金鑰用途
apiKey用於 Server-api 串接認證
clientKey用於 SDK 串接認證
signKey用於 Event 通知串接認證

2. 技術串接及申請

SHOPLINE Payments 提供 SDK+API 的技術串接,特店網站需要將 SDK 整合到結帳頁,配合 Server-API 完成結帳頁收款; 主要分為以下重點步驟:

  1. 收款 SDK 整合,整合方式可見SDK 串接
  2. 收款 Server-API 串接,SHOPLINE Payments 目前提供的 API 功能:API 列表
  3. Webhook Event 通知串接,串接方式可見:通知[Event]
  4. 特店自行串接
  5. 使用 SHOPLINE Payments 提供的沙盒環境資源測試
  6. 使用申請產生的正式 apiKey/ clientKey/ signKey 上線正式環境

SHOPLINE Payments 提供以下收款業務場景串接:

  1. 一般收款,支援信用卡、信用卡分期、ATM銀行轉帳、街口支付、中租 zingla 銀角零卡分期、LINE Pay等收款功能;一般付款串接
  2. 綁卡/快捷/定期收款,支援特店提供給顧客綁定常用信用卡進行快速、定期扣款等收款功能;綁卡/快捷/定期付款串接

3.沙盒環境串接

特店技術人員依據串接規格完成 SDK 及 Server-API 整合後,可串接 SHOPLINE Payments 沙盒環境進行聯調驗證

  1. 串接前,可聯絡 SHOPLINE Payments 業務窗口建立串接群組,以便溝通與解決串接問題
  2. 沙盒環境整合資源可參照:沙盒環境串接資源
  3. 沙盒環境需完成付款、退款、Event 通知等功能串接驗證,綁卡/快捷場景需完成會員及付款工具功能驗證
  4. 沙盒環境驗證完成後,進行正式環境串接

4. 正式環境驗證

特店技術人員在完成沙盒環境串接驗證後,可安排進行正式環境串接,正式環境串接後,即可使用 SHOPLINE Payments 進行收款

  1. 設定 apiKey, clientKey, signKey, 此為申請階段網站後台產生的金鑰
  2. webhook 地址设置: 通知[Event]
  3. 正式環境驗證付款、退款、Event 通知等功能

三、環境資訊