Skip to main content
啟潤支付會為以下事件類型發送 Webhook 通知。

事件類型

目前訂單整合不會發送 order.closed Webhook。請呼叫 GET /v1/orders/{orderId} 核對 FAILED、CLOSED 或 REVOKED 等未付款終態,參見訂單管理。

事件物件結構

所有 Webhook 事件共享相同的頂層結構:

order.paid

客戶成功完成付款時發送。
這是最重要的事件。用它來完成訂單處理 — 例如,為使用者的帳戶充值額度。

order.refunded

訂單退款已生效時發送。你可以用此事件更新權益、餘額或對帳記錄。 有關控制台退款申請流程和退款狀態定義,請查看訂單退款。

爭議事件(開通後可用)

當你的帳戶支援並開通爭議處理時,還可能收到以下通知。是否可用取決於支付渠道和營運配置,請向 Kyren 支援確認。參見爭議管理。 兩種事件使用相同的頂層結構,data 包含以下案件快照;可空欄位可能暫不可用: 這些通知用於同步案件資訊。僅 status 變化不代表餘額已變動,請結合資金欄位和控制台記錄對帳。即使 shared_order_projection 為 true,資金金額仍屬於單個案件。

處理事件

以下是在 Webhook 端點中處理事件的方式:
處理函式必須在持久化完成後才確認事件。較長的處理請採用持久化佇列方案,只有儲存成功後才能返回 2xx。