启润支付会为以下事件类型发送 Webhook 通知。
事件类型
| 事件 | 描述 | 触发条件 |
|---|
order.paid | 付款已确认 | 客户完成收银台付款 |
事件对象结构
所有 Webhook 事件共享相同的顶层结构:
{
"id": "evt_abc123",
"type": "order.paid",
"created_at": 1736932500000,
"data": {
// 事件特定数据
}
}
| 字段 | 类型 | 描述 |
|---|
id | string | 唯一事件标识符(用于去重) |
type | string | 事件类型 |
created_at | integer | Unix 毫秒时间戳 |
data | object | 事件特定载荷 |
order.paid
客户成功完成付款时发送。
{
"id": "evt_abc123",
"type": "order.paid",
"created_at": 1736932500000,
"data": {
"order_id": "order_def456",
"product_id": "prod_abc123",
"customer_email": "customer@example.com",
"amount": "9.99",
"currency": "USD",
"net_amount": "9.29",
"paid_at": 1736932500000,
"metadata": { "user_id": "u_123" }
}
}
| 字段 | 类型 | 描述 |
|---|
order_id | string | 订单 ID |
product_id | string | 购买的产品 |
customer_email | string | 客户邮箱地址 |
amount | string | 总支付金额 |
currency | string | 三字母货币代码 |
net_amount | string | 扣除手续费后的金额 |
paid_at | integer | 付款确认时间(Unix 毫秒时间戳) |
metadata | object | null | 创建 Checkout Session 时传入的 metadata |
这是最重要的事件。用它来完成订单处理 — 例如,为用户的账户充值额度。
处理事件
以下是在 Webhook 端点中处理事件的方式:
app.post('/webhooks/kyren', (req, res) => {
// ... 先验证签名 ...
const event = JSON.parse(req.body.toString());
switch (event.type) {
case 'order.paid':
handleOrderPaid(event.data);
break;
default:
console.log(`未处理的事件类型: ${event.type}`);
}
res.status(200).send('OK');
});