开发文档

首页/开发文档

开放接口文档

收银台下单、API 下单、订单查询、退款、通知、签名和 WordPress 插件

内容与商户控制台保持同步。所有接口和签名都必须由商户服务端调用,不要在浏览器暴露商户 KEY。

notifyUrl 非必填;未配置回调时,商户必须通过查询订单接口主动确认支付结果。

当前支持:扫码支付、JSAPI 支付和支付宝 H5 支付;支付宝 H5 支付支持全部主体,暂不支持微信外浏览器 H5 支付。

主网关https://jpay.hzjianban.com
备用网关(支持 IPv6)https://api.jian-pay.com

查询订单

按简付平台订单号或商户订单号查询单笔订单状态。查询接口同样需要使用商户 KEY 参与签名。

查询接口POST /open/payment/pay/info
参数类型必填说明
商户号 clientNostring是当前订单所属商户号。
orderIdstring二选一简付平台订单号,即下单接口返回的 orderId。
merchantOrderNostring二选一商户下单时传入的 orderNo;与 orderId 至少填写一个。
timestampstring否请求时间戳,建议传。
signstring是MD5 签名结果,小写。
sign_typestring是固定传 MD5。

按简付平台订单号查询

POST /open/payment/pay/info
Content-Type: application/json

{
  "clientNo": "JP26070612345678",
  "orderId": "PAY202607080001000001",
  "timestamp": "1783500001",
  "sign_type": "MD5",
  "sign": "md5签名"
}

按商户订单号查询

POST /open/payment/pay/info
Content-Type: application/json

{
  "clientNo": "JP26070612345678",
  "merchantOrderNo": "P202607080001",
  "timestamp": "1783500001",
  "sign_type": "MD5",
  "sign": "md5签名"
}

响应字段

字段类型必返说明
serverTimenumber是服务端当前 Unix 秒级时间戳;倒计时应以此校时,不依赖浏览器时区或设备时钟。
payExpireAtnumber/null是保存的支付截止时间(Unix 秒);历史订单无可靠截止时间时返回 null。到期不等于关单已经确认。
closeStatusstring是NONE 未申请关单;PROCESSING 关单处理中;CLOSED 关单处理已完成,localClosed 用于识别平台本地关闭;PAID 订单已付款。
closeConfirmedboolean是是否已完成关单处理,需同时检查 status=4。汇付本地关闭也返回 true;localClosed=true 时仍需处理迟到付款。
localClosedboolean是是否为汇付平台本地关闭;true 时不再发起汇付关单,但后续真实支付成功仍会更新订单并通知商户。
orderIdstring是简付平台订单号。
clientNostring是当前订单所属商户号。
merchantOrderNostring是商户下单时传入的 orderNo。
amountnumber是订单金额,单位分。
statusnumber是订单状态:0-待发起,1-处理中,2-支付成功,3-支付失败,4-已关闭。
goodsNamestring否商品名称。
payMethodstring否支付方式。
payTypestring否支付类型。
paramstring否下单时传入的附加参数,原样返回。
paidAtstring否支付完成时间,格式 YYYY-MM-DD HH:mm:ss。

返回示例

{
  "code": 1000,
  "message": "success",
  "data": {
    "orderId": "PAY202607080001000001",
    "clientNo": "JP26070612345678",
    "merchantOrderNo": "P202607080001",
    "amount": 100,
    "status": 2,
    "goodsName": "测试商品",
    "payMethod": "wx",
    "payType": "jsapi",
    "param": "user_id=1001",
    "paidAt": "2026-07-08 12:30:00"
  }
}
主动查询与重试规则
  • status=4(已关闭)时暂停主动查询,取消该订单的轮询、定时重试和重复关单任务,不再等待 closeConfirmed 变化。
  • status=2(支付成功)时完成幂等业务处理并停止轮询;仅对未完成订单做有次数和截止时间的查询补偿,逐步延长查询间隔。
  • 订单不存在时停止自动重试并核对订单号;程序重启恢复任务时,也不要重新加入已关闭订单。
  • 已配置 notifyUrl 时,关闭后的迟到付款通过异步通知处理;先验签并按订单号幂等处理,再按业务决定履约或退款。
  • 未配置 notifyUrl 时不会收到异步通知;关闭后如需核对资金结果,应安排低频、有期限的对账补偿,避免持续高频轮询。
和支付通知的关系
  • 查询订单是商户主动调用,返回结构为 code + message + data。
  • 支付通知回调是平台主动 POST 到 notifyUrl,并附带 sign、sign_type 供商户验签。
  • 两者的核心业务字段都包含 clientNo、orderId、merchantOrderNo、amount、status 等。
  • 配置 notifyUrl 时优先按回调处理;回调未及时到达时主动查单补偿。
  • 未配置 notifyUrl 时不会回调,必须通过主动查单确认支付结果。