文档目录 · 查询代付

查询代付

POST /api/v1/payout/query

字段 类型 必填 说明
platform_order_no string 条件 平台订单号;两个订单号至少提供一个
merchant_order_no string 条件 商户订单号;同时提供时须指向同一会话或订单
sync_provider boolean 否 默认 false;正式订单为 processing 时设为 true 获取最新状态,参与签名

请求示例:

{
  "api_key": "<PAYOUT_API_KEY>",
  "merchant_id": "merchant_1001",
  "merchant_order_no": "OUT202609160001",
  "timestamp": "1789516800",
  "nonce": "query-payout-001",
  "sign": "<64位小写HMAC-SHA256>",
  "sync_provider": false
}

会话响应示例:

{
  "code": 0,
  "message": "OK",
  "data": {
    "checkout_mode": "cashier",
    "platform_order_no": "W202609160001",
    "merchant_order_no": "OUT202609160001",
    "amount": "50.00",
    "currency": "MYR",
    "status": "awaiting_payment_method",
    "expired_at": "2026-09-16T15:30:00Z"
  },
  "request_id": "req_01JEXAMPLE"
}

正式订单返回订单号、金额、币种、status、audit_status、channel_code、fee_amount、net_amount、frozen_amount、created_at 和脱敏 receiver;net_amount = amount + fee_amount,表示订单总扣款,并与 frozen_amount 相同。例如 amount=30.00、fee_amount=0.45 时,net_amount=30.45。成功时该金额被实际扣除,失败时该金额会解冻。channel_order_no、completed_at 按实际情况返回。完整收款账号和姓名不返回。

正式订单状态 说明 终态
reviewing 受理中 否
processing 处理中 否
success 代付成功 是
failed 代付失败 是
cancelled 已取消 是

通道处于 maintenance 时仍可查询已有订单,processing 订单仍可使用 sync_provider=true 尝试同步最新状态。超时或结果不明时订单可能继续为 processing;等待查询或通知,不据此判断失败或重新创建。

搜索文档