Skip to main content
WEBHOOK

事件类型

所有订单通知使用 event_name: STOCKS_ORDER,通过 event_type 区分订单阶段。

订单快照

三个事件共用下方的通知封装和订单字段定义。data.order 是事件发生时的订单快照。
  • 处理中:completed_at、failed_at、failure_code 和 failure_message 为空。
  • 已完成:completed_at 有值,失败相关字段为空。通知提供成交数量、本金、费用和总金额;没有可用结算价格时,成交价可以为空。
  • 失败:failed_at、failure_code 和 failure_message 有值,completed_at 为空。成交数量、金额和费用为空。失败码包括 STOCKS_ORDER_FAILED,以及订单创建后报价在执行前过期时的 STOCKS_QUOTE_EXPIRED。

处理通知

通知可能重复或乱序到达。处理中通知晚于终态通知到达时,不要回退订单状态。通知投递超时或缺少交易哈希本身不表示订单失败。 按照接收订单 Webhook完成验签、持久化以及投递与业务事件去重。使用查询订单核对当前结果。

请求体

application/json
version
string
必填

Version configured for the webhook subscription.

event_name
enum<string>
必填
可用选项:
STOCKS_ORDER
event_type
enum<string>
必填
可用选项:
stocks.order.processing,
stocks.order.completed,
stocks.order.failed
event_id
string<uuid>
必填

Notification identifier. HTTP retries of the same delivery record retain this identifier.

source_id
string<uuid>
必填

Order identifier; equals data.order.order_id.

data
object
必填

响应

Event durably received.