开发文档

首页/开发文档

开放接口文档

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

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

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

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

主网关https://jpay.hzjianban.com

备用网关（支持 IPv6）https://api.jian-pay.com

API 下单

建议有营业执照的商户在已有自建支付页、需要自行控制支付拉起时使用；小微主体优先使用收银台下单。

使用建议

API 下单仅建议有营业执照的个体工商户或企业主体使用，并由商户自己的服务端调用。
小微主体不建议接入 API 下单，直接使用收银台下单即可，简付会返回收银台链接或二维码。
如果没有自建支付页，或者只需要扫码支付、H5 跳转，请使用“收银台下单”；H5 支付仅个体工商户和企业主体支持。

创建订单接口POST /open/payment/pay/api-create

参数	类型	必填	说明
商户号 clientNo	string	是	业务开通成功后在商户台查看，接口字段名为 clientNo。
amount	number	是	订单金额，单位是分。
orderNo	string	是	商户订单号，同一商户号下必须唯一。
goodsName	string	是	商品名称。
payMethod	string	是	支付方式，可选值：wx、alipay。
payType	string	是	API 下单支付类型，可选值：jsapi、native。H5 支付通过收银台 payUrl 使用，不传 h5。
methodExpand	object	条件必填	支付扩展参数，例如微信 JSAPI 需要传 sub_appid、sub_openid。
notifyUrl	string	否	商户自己的服务端支付通知地址。不填则不发送回调。
returnUrl	string	否	支付完成后的页面跳转地址。
param	string	否	附加参数，通知时原样返回。
timestamp	string	否	请求时间戳，建议传。
sign	string	是	MD5 签名结果，小写。
sign_type	string	是	固定传 MD5。

请求示例

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

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

响应字段

字段	类型	必返	说明
orderId	string	是	简付平台订单号。
clientNo	string	是	当前下单使用的商户号。
merchantOrderNo	string	是	商户下单时传入的 orderNo。
amount	number	是	订单金额，单位分。
status	number	是	订单状态：0-待发起，1-处理中，2-支付成功，3-支付失败，4-已关闭。
payMethod	string	否	支付方式，如 wx、alipay。
payType	string	否	支付类型，如 jsapi、native。
qrCode	string	条件返回	扫码支付时返回的二维码内容链接。
payActionUrl	string	条件返回	部分支付场景返回的可直接跳转地址。
payInfo	object	条件返回	JSAPI 场景的拉起支付参数。

返回示例

{
  "code": 1000,
  "message": "success",
  "data": {
    "orderId": "PAY202607080001000002",
    "clientNo": "JP26070612345678",
    "merchantOrderNo": "P202607080002",
    "amount": 100,
    "status": 1,
    "payMethod": "wx",
    "payType": "jsapi",
    "qrCode": "",
    "payActionUrl": "",
    "payInfo": {
      "appId": "wx807ca1e2f99e3039",
      "timeStamp": "1783500000",
      "nonceStr": "a8f3k2m9",
      "package": "prepay_id=wx...",
      "signType": "RSA",
      "paySign": "..."
    }
  }
}

支付方式和支付类型

收银台方案只需要传 payMethod；API 下单需要同时传 payMethod 和 payType。

payMethod	payType	内部交易类型	适用场景
wx	jsapi	T_JSAPI	微信内 JSAPI / 公众号支付
wx	native	T_NATIVE	微信扫码支付
alipay	native	A_NATIVE	支付宝扫码支付
alipay	jsapi	A_JSAPI	支付宝内 JSAPI 支付