开发文档

首页/开发文档

开放接口文档

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

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

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

当前支持:扫码支付、JSAPI 支付和 H5 支付;H5 支付仅个体工商户和企业主体支持。

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

收银台下单

适合不自建支付页的场景。简付负责展示收银台和拉起支付。

1
服务端创建订单

按 MD5 规则签名后调用下单接口。

2
前端打开收银台

使用返回的 payUrl 跳转,或展示 payQrcodeUrl

3
确认支付结果

按回调或主动查单结果更新你自己的订单状态。

创建订单接口POST /open/payment/pay/create
参数类型必填说明
商户号 clientNostring业务开通成功后在商户台查看,接口字段名为 clientNo。
amountnumber订单金额,单位是分。1 表示 0.01 元。
orderNostring商户订单号,同一商户号下必须唯一。
goodsNamestring商品名称,会展示在收银台和订单记录中。
payMethodstring支付方式,可选值:wx、alipay。
notifyUrlstring商户自己的服务端支付通知地址。不填则不发送回调。
returnUrlstring支付完成后的页面跳转地址,只影响前端跳转。
paramstring附加参数,通知时原样返回。
timestampstring请求时间戳,建议传秒级时间戳。
signstringMD5 签名结果,小写。
sign_typestring固定传 MD5。

请求示例

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

{
  "clientNo": "JP26070612345678",
  "amount": 100,
  "orderNo": "P202607080001",
  "goodsName": "测试商品",
  "payMethod": "wx",
  "notifyUrl": "https://example.com/pay/notify",
  "returnUrl": "https://example.com/pay/result",
  "param": "user_id=1001",
  "timestamp": "1783500000",
  "sign_type": "MD5",
  "sign": "md5签名"
}

响应字段

字段类型必返说明
orderIdstring简付平台订单号,后续查单和对账使用。
clientNostring当前下单使用的商户号。
merchantOrderNostring商户下单时传入的 orderNo。
amountnumber订单金额,单位分。
statusnumber订单状态:0-待发起,1-处理中,2-支付成功,3-支付失败,4-已关闭。
payUrlstring收银台地址,可直接跳转。
payQrcodeUrlstring收银台二维码图片地址,PC 场景可直接用 img 展示。

返回示例

{
  "code": 1000,
  "message": "success",
  "data": {
    "orderId": "PAY202607080001000001",
    "clientNo": "JP26070612345678",
    "merchantOrderNo": "P202607080001",
    "amount": 100,
    "status": 1,
    "payUrl": "https://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001",
    "payQrcodeUrl": "https://quickchart.io/qr?size=300&text=https%3A%2F%2Fjpay.hzjianban.com%2F%23%2Fpay%3ForderId%3DPAY202607080001000001"
  }
}