开发文档

首页/开发文档

开放接口文档

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

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

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

网关https://jpay.hzjianban.com

接入指南

先把下单、回调、查单三件事跑通,再补充支付页面展示。

1
准备接入信息

在 API安全 页面拿到商户号 clientNo 和商户 KEY;如果需要回调,再准备自己的 notifyUrl。

2
服务端发起下单

按 MD5 规则签名后调用收银台下单或 API 下单接口。

3
前端拉起支付

收银台使用 payUrl 或 payQrcodeUrl;API 下单使用 qrCode、payActionUrl 或 payInfo。

4
确认支付和退款结果

配置 notifyUrl 时处理回调;未配置或回调未到时,主动调用查单接口。退款以退款查询结果为准。

接入场景选择

  • PC 支付:使用收银台下单,展示返回的 payQrcodeUrl,用户扫码支付。
  • H5 支付:使用收银台下单,获取 payUrl 后跳转到简付收银台。
  • 自建支付页:使用 API 下单;应用内拉起通常选择 JSAPI,PC 扫码通常选择 Native。

支付通知回调

  • notifyUrl 非必填;不填则平台不会发送支付通知回调。
  • 填写时必须使用自己的服务端地址,不能填写前端页面地址。
  • 收到成功通知后返回纯字符串 success。
  • 同一笔订单可能重复通知,必须按 orderId 或商户订单号幂等。

资金与结算

  • 资金由签约支付通道按通道规则清算。
  • 商户收款后按支付机构清算周期结算到绑定银行卡。
  • 结算记录可在商户控制台查看,具体以通道规则为准。

退款处理

  • 如需商户通过 OpenAPI 发起退款,需先在商户控制台 API安全 中开启退款权限。
  • 退款申请成功返回 code=1000 时,仍需要根据 data.status 判断退款是否成功。
  • 退款失败时读取 data.errorMessage 作为失败原因。

接入检查清单

以下信息准备齐全后,就可以开始联调。

商户号 clientNo
商户 KEY
服务端下单接口
可选:服务端支付通知回调接口 notifyUrl
通知验签和幂等逻辑
订单主动查询补偿逻辑
# 简付开放接口接入 Skill

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

前置准备:
- 商户号:clientNo
- 商户密钥:KEY
- 支付通知回调地址:notifyUrl(非必填;填写时必须是自己的服务端接口)

推荐接入流程:
1. 服务端按 MD5 规则签名后发起下单。
2. 收银台方案使用 payUrl 或 payQrcodeUrl。
3. API 方案使用 qrCode、payActionUrl 或 payInfo。
4. 配置 notifyUrl 时,以支付通知回调为准更新订单。
5. 未配置 notifyUrl 或回调未及时到达时,主动调用查单接口。

接口:
- 收银台下单:POST https://jpay.hzjianban.com/open/payment/pay/create
- API 下单:POST https://jpay.hzjianban.com/open/payment/pay/api-create
- 查询订单:POST https://jpay.hzjianban.com/open/payment/pay/info
- 申请退款:POST https://jpay.hzjianban.com/open/payment/refund/create
- 退款查询:POST https://jpay.hzjianban.com/open/payment/refund/query

退款:
- OpenAPI 退款需要先在商户控制台 API安全 中开启退款权限。
- refundAmount 使用分为单位,10 表示 0.10 元。
- 退款接口返回 code=1000 只表示接口调用成功,退款最终结果以 data.status 为准。
- data.status=3 表示退款失败,失败原因读取 data.errorMessage。

签名:
1. 排除 sign、sign_type 和空值字段。
2. 剩余字段按 ASCII 升序排序。
3. 拼接为 key=value&key=value。
4. object 参数先转 JSON 字符串。
5. 商户 KEY 直接拼在待签名串末尾。
6. sign = md5(待签名串 + 商户 KEY).toLowerCase()

回调:
- 仅在配置 notifyUrl 时发送。
- 平台可能多次回调,业务处理必须幂等。
- 收到通知先验签,再校验金额、商户号和订单号。
- 处理成功后返回纯字符串 success。