Skip to main content
啟潤支付使用標準 HTTP 狀態碼來表示 API 請求的成功或失敗。

HTTP 狀態碼

錯誤回應格式

由 API 應用層處理的錯誤使用以下 JSON 結構。認證中介軟體和代理錯誤的回應本體可能為空或採用其他格式,請先檢查 HTTP 狀態再解析 JSON。
error 是可選欄位,有欄位詳情時才包含。field 和 reason 也可能分別省略。不要依賴錯誤訊息的固定文字。

應用錯誤碼

這些錯誤碼表示錯誤條件。業務錯誤可能使用 HTTP 400,不要根據 code 的前幾位推斷 HTTP 狀態。

常見錯誤

400 錯誤請求

請求本體或參數無效時返回。

401 未認證

API 密鑰缺失或被拒絕時返回。認證入口不保證返回 JSON 回應本體。應用層未認證錯誤若返回 JSON,其 code 為 40101。

404 未找到

請求的資源不存在時返回。

429 請求過多

超過配置的頻率限制時返回。預設值為普通 API 請求每個 IP 每分鐘 100 次,POST /v1/checkouts 建立收銀台為每個已認證商戶每分鐘 60 次。限制可配置,不代表生產環境保證提供的配額。
在你的整合中實現指數退避策略,以優雅地處理頻率限制。

成功回應格式

公開商戶 JSON API 的成功回應包含 code: 0 和 message: "success"。Epay 相容回應和檔案下載使用各介面規定的格式。
對於分頁介面,data 欄位包含 items 和 pagination: