Webhook 事件
1. 入账相关
| 功能场景 | 事件名称 | 触发条件 | 事件内容 |
|---|---|---|---|
| 订单模式 | payment.order.status.updated | 支付订单状态发生变更，会触发的节点包括： - Pending: 此状态通知仅限于通过支付链接成功创建订单时触发。- Completed: 在订单有效期内收到全额付款。- Expired: 订单有效期内没有已完成的充币交易，或者订单已被取消。- Underpaid: 订单有效期内存在已完成的充币交易，但实收金额少于应付金额。 | 请参考 Get pay-in order information 的响应参数说明。 |
| 订单模式 | payment.transaction.late | 在支付订单已处于终态（Underpaid、Expired 或 Completed）后又收到一笔通过合规筛查的充币交易。 | 该数据结构包含了 Get transaction information 响应参数中的所有字段，此外还包含以下字段： - acquiring_type: 收款类型。Order 表示订单模式。 - order_id: 支付订单 ID。- psp_order_code: 您的系统中用于标识该订单的唯一标识符。 |
| 充值模式 | payment.transaction.created | 充值地址检测到有新的充币交易。 | 该数据结构包含了 Get transaction information 响应参数中的所有字段，此外还包含以下字段： - acquiring_type: 收款类型。TopUp 表示充值模式。 - payer_id: Cobo 分配的用于跟踪和识别付款人的唯一标识符。 - custom_payer_id: 您的系统中用于跟踪和识别付款人的唯一标识符。 |
| 充值模式/ 订单模式 | payment.transaction.completed | 充值模式下，充币交易通过合规筛查，资金已成功入账并计入实收金额。 订单模式下，一笔订单在有效期内收到的每笔交易，通过合规筛查，资金已成功入账并计入实收金额。 | 同上 |
| 意外入账 | payment.transaction.external.created | 检测到非预期充币交易（包括：非当前订单/充值计划内的交易，或非支付服务支持的币种充币）。 | 该数据结构包含了 Get transaction information 响应参数中的所有字段 |
| 意外入账 | payment.transaction.external.completed | 非预期充币交易已通过合规筛查并成功入账，资金已计入开发者余额。 | 同上 |
| 入账检查 | payment.transaction.failed | 入账交易合规筛查不通过。 | 该数据结构包含了 Get transaction information 响应参数中的所有字段，此外还包含以下字段： - acquiring_type: 收款类型。Order 表示订单模式，TopUp 表示充值模式。- order_id: 支付订单 ID。 - psp_order_code: 您的系统中用于标识该订单的唯一标识符。 - payer_id: Cobo 分配的用于跟踪和识别付款人的唯一标识符。 - custom_payer_id: 您的系统中用于跟踪和识别付款人的唯一标识符。 |
2. 资金转出相关
| 功能场景 | 事件名称 | 触发条件 | 事件内容 |
|---|---|---|---|
| 退款 | payment.refund.status.updated | 退款单状态发生变更，会触发的节点包括： - Pending：此状态通知仅限于通过退款链接成功创建退款单时触发。- Completed: 所有退款交易均已完成。- PartiallyCompleted: 部分退款交易已完成，部分退款交易失败。- Failed: 所有退款交易均失败。 | 请参考 Get refund order information 的响应参数说明 |
| 单目的地资金转出 | payment.settlement.status.updated(即将废弃） | 资金转出请求状态变更，会触发的节点包括： - Completed: 所有资金转出已完成。- PartiallyCompleted: 部分资金转出已完成，部分资金转出失败。- Failed: 所有资金转出均失败。 | 请参考 Get settlement request information 的响应参数说明 |
| 单目的地资金转出 | payment.payout.status.updated | 资金转出请求状态变更，会触发的节点包括： - Completed: 所有资金转出已完成。- PartiallyCompleted: 部分资金转出已完成，部分资金转出失败。- Failed: 所有资金转出均失败。 | 请参考 Get payout information 的响应参数说明 |
| 批量下发加密货币 | payment.bulk_send.status.updated | 批量下发请求状态变更，会触发的节点包括： - Completed: 所有下发已完成。- PartiallyCompleted: 部分下发已完成，部分下发失败。- Failed: 所有下发均失败。 | 请参考 Get bulk send information 的响应参数说明 |
提示
为了保证数据的绝对准确性并避免并发冲突，Webhook 消息体中不会包含实时余额变动和详细扣费信息。如果您存在以下使用场景，请参考下列提示说明：- 若需要根据Webhook通知及时更新余额，您可以： -在接收到Webhook时，立即调用List merchant balances 或 Get developer balances 接口获得准确的余额信息，再进行内部记账。
- 若需要及时知道Webhook所指交易引发的扣费信息，以便于关联交易和扣费进行对账，您可以： -使用对应的查询交易信息接口和 Generate reports 获取扣费报表，来做数据的核对。
- 若需要及时知道Webhook所指交易引发的Fee Station余额的变动情况，保证后续不因Fee Station余额不足而影响业务，您可以： -定期调用 List Fee Station token blance 查询fee station余额，并根据业务的消耗频率做内部报警策略，避免欠费影响正常业务运行。