驗證
每個請求均經 HTTPS 發出，並以 Bearer 令牌形式附帶您的私人 API 密鑰。經普通 HTTP 發出或未附有效密鑰的請求會被拒絕。
請將私人密鑰保存在您的伺服器上，切勿放入原始碼管理系統、瀏覽器或流動應用程式。測試環境與正式環境的密鑰各不相同，並分別發出。
慣例
- 請求及回應主體均採用 JSON 格式。
- 金額以該貨幣的最小單位表示（例如「仙」）。
- 每筆付款、退款及商業付款均以付款令牌識別。
- 您自己的參考編號以
orderNumber傳遞，並會在回調中返回。
資源
付款
建立、查閱及列出付款；確認或拒絕兩步付款。
- POST /api/v1/payments
- GET /api/v1/payments/{token}
- GET /api/v1/payments
- POST /api/v1/payments/confirm
- POST /api/v1/payments/decline
退款
全數退款，或傳入金額以作部分退款。
- POST /api/v1/refunds
商業付款
發起支援的商業付款操作。
- POST /api/v1/payouts
餘額
某一貨幣的可用及凍結金額。
- GET /api/v1/balance
爭議
您賬戶最近的爭議記錄。
- GET /api/v1/disputes/list
通知
發送至您伺服器的狀態變更。
- POST {callbackUrl}
付款狀態
| 狀態 | 最終 | 含義 |
|---|---|---|
| init | 否 | 付款已建立。 |
| pending | 否 | 客戶正在完成付款。 |
| approved | 是 | 付款已成功完成。 |
| declined | 是 | 付款未能完成。 |
| refunded | 是 | 付款已退款。 |
| expired | 是 | 付款已被放棄。 |
錯誤
調用失敗時會返回 success: false 及錯誤清單，每項錯誤均附有代碼及類別：
| 類別 | 含義 |
|---|---|
| api_error | 彩虹匯方面罕見的問題。 |
| authentication_error | 請求未能通過驗證。 |
| invalid_request_error | 參數缺漏或無效。 |
| processing_error | 操作未能處理。 |
參數、驗證規則及錯誤代碼均列於 API 技術文件 (opens in a new tab)。如本頁與技術文件有任何分歧，概以技術文件為準。
生命週期
由請求到回調。
商戶伺服器
以您的私人密鑰建立付款。
POST /api/v1/payments彩虹匯 API
驗證請求並返回付款令牌。
200 · token付款處理
客戶付款；如有需要，會進行驗證。
結果
付款達至最終狀態。
approved | declined回調
狀態發送至您的回調 URL。
POST callbackUrl