跳至主要内容

快速開始

本指南將幫助您在 5 分鐘內完成支付系統 API 的基本整合。

📋 前置準備

在開始之前,請確保您已經獲得以下資訊:

項目說明
platform_id平台商戶 ID
platform_key平台密鑰(用於簽名)
authorization授權識別碼(用於請求頭,部分 API 需要)
API 端點測試/生產環境 URL

🔑 簽名機制

所有 API 請求都需要包含 sign 參數。簽名生成步驟:

  1. 將所有非空參數按 ASCII 升序 排列
  2. 使用 key=value 格式拼接,以 & 連接
  3. 在末尾追加平台密鑰
  4. 進行 MD5 加密,輸出 32 位小寫字串

詳細說明請參考:簽名規範

📥 代收流程 (Deposit)

sequenceDiagram
participant 商戶
participant 支付系統
participant 用戶

商戶->>支付系統: 1. 創建代收訂單
支付系統-->>商戶: 返回支付連結
商戶->>用戶: 2. 展示支付頁面
用戶->>支付系統: 3. 完成支付
支付系統->>商戶: 4. 回調通知
商戶-->>支付系統: 返回 SUCCESS

創建代收訂單

curl -X POST https://api.your-domain.com/gateway/api/v1/payments \
-H "Content-Type: application/json" \
-d '{
"platform_id": "your_platform_id",
"service_id": "CN_BANK_DEPOSIT",
"merchant_order_id": "ORDER_12345",
"amount": 10000,
"notify_url": "https://your-domain.com/callback",
"sign": "your_calculated_sign"
}'

📤 代付流程 (Withdraw)

curl -X POST https://api.your-domain.com/gateway/api/v1/payouts \
-H "Content-Type: application/json" \
-d '{
"platform_id": "your_platform_id",
"service_id": "CN_BANK_WITHDRAW",
"merchant_order_id": "PAYOUT_12345",
"amount": 10000,
"bank_code": "ICBC",
"card_no": "6222021234567890123",
"card_holder": "張三",
"notify_url": "https://your-domain.com/callback",
"sign": "your_calculated_sign"
}'

✅ 下一步