跳到正文

API

本页内容

事件

处理全部 16 种 Paymos webhook 事件类型,显式读取资源状态和终态语义。

Paymos 发布 16 种事件类型:账单 8 种、转出 5 种、收款通道 3 种。在端点级别按类目订阅;类目内的事件名称不可单独勾选。

账单事件

事件 含义 终态
invoice.awaiting_payment 深度重组移除了所有已计数的转账,账单回退到等待付款。首次进入等待付款的流转不发出此事件 否
invoice.confirming 已检测到付款,正在等待所需的区块链最终性 否
invoice.underpaid_waiting 已收金额低于应付金额,账单仍可接受付款 否
invoice.paid 应付金额已付清 是
invoice.paid_over 支付超过应付金额;实收全额入账 是
invoice.underpaid 账单达到最终的少付状态 是
invoice.expired 账单过期,没有合格付款 是
invoice.cancelled 商户取消了账单 是

转出事件

事件 含义 终态
withdrawal.created 转出已被受理并创建 否
withdrawal.processing 出账交易已在链上观测到,交易哈希可用 否
withdrawal.completed 出账交易已在链上完成 是
withdrawal.failed 转出失败并达到最终状态 是
withdrawal.cancelled 转出在完成前被取消 是

收款通道事件

事件 含义 终态
payment_channel.deposit.confirming 通道地址收到一笔转账,正在等待所需的区块链最终性 否
payment_channel.deposit.reorged 交易被链重组剔除。同一笔交易若被重新打包,同一条充值回到 confirming 否
payment_channel.deposit.confirmed 充值已结算,净额计入你的余额 是

没有失败事件:交易不再被重新打包时,充值就停在 reorged,不会再发出任何事件。

处理规则

  • 按精确的 event_type 路由;对未知的未来类型安全忽略并告警待查。
  • 从负载中读取 data.status 和 data.is_final,不要从事件名称反推状态。
  • 不要假设投递顺序。并行投递和重试可能让更新的资源快照先到达。
  • 终态事件对该资源状态机是最终的。同一 event_id 的重复投递仍是重复,不是又一次流转。
  • 业务状态按 data 里的资源标识去重(inv_…、wdr_…、pcd_…),它在每一次流转、每一个端点上都不变。event_id 标识的是一次投递,不是一笔付款。

公共信封和资源字段见 负载契约。