Skip to main content
Version: 1.0.0

Open API

Treasury Service OpenAPI v1：收款人（Payee）与出款（Payout）接口，以及 Payout 状态 Webhook 回调。

鉴权与公共 Header​

  • 业务身份通过 Header x-p-business-id 指定（必须为 Active 商户 UUID）。
  • 网关层鉴权（API Key / Signature 等）通常由上游网关完成；本服务侧校验 business 与业务参数。
  • OpenAPI success/失败响应体使用 code + message（非内部接口的 error_code/error_msg）。

success响应统一结构​

{ "code": 200, "message": "succeed", "data": { ... } }

错误响应统一结构​

{ "code": 820001, "message": "Invalid payee" }

code 为业务错误码（数字），message 可随 x-i18n-lang 本地化。

Webhook 说明​

出款生命周期账本事件会推送到商户在 Merchant Services Setting 中配置的 callback_url。 仅当该笔 payout 创建时带有 reference_id（落库为 ref_id），且商户已配置 app_id + callback_url 时才会推送。 取消出款实际产生的 ledger action 多为 Payout Reversal（代码虽订阅了 Payout Cancel，取消路径通常走 Reversal）。