Skip to main content
當你希望服務端透過 API 建立 Kyren Pay Checkout Session 時,請使用本指南。 如果你想先了解控制台,請從 控制台總覽 開始。

前提條件

  • 一個啟潤支付商戶帳號(點此註冊
  • 你的 API 密鑰(在控制台的「開發者」頁面取得)
  • 已在控制台或透過 Products API 建立產品
  • 一個可以安全保存 API 密鑰的服務端環境
  • 上線前用於接收付款通知的 Webhook 端點

第一步:取得 API 密鑰

註冊後,前往 控制台 > 開發者,複製你的 API 密鑰。
  • 生產密鑰kyren_live_xxxxxxxxxxxx — 用於正式收款
請妥善保管你的 API 密鑰。切勿在客戶端程式碼或公開倉庫中暴露密鑰。

第二步:建立產品

建立一個代表你所售商品的產品:
儲存回應中的 id,後續建立 Checkout Session 時需要用到。

第三步:建立 Checkout Session

當客戶要付款時,建立一個 Checkout Session:
當本次 Checkout 需要展示不同於商戶帳戶名稱的活動、店鋪或應用名稱時,可以傳入 displayMerchantName 回應中包含 url 欄位 — 將客戶重新導向到該 URL 即可完成付款。

第四步:重新導向到收銀台

將客戶重新導向到第三步返回的 Checkout URL。客戶會看到一個託管的支付頁面,可以選擇喜歡的支付方式。

第五步:處理 Webhook

付款完成後,啟潤支付會向你的伺服器發送 Webhook:
控制台 > 開發者 > Webhook 設定 中配置你的 Webhook URL。

下一步

認證

了解 API 認證詳情

Webhook 簽名

實現安全的 Webhook 簽名驗證

測試

使用 Kyren 提供的 Staging 憑證或低風險真實付款安全測試

程式碼範例

查看 Python、Node.js、Go 等語言的範例