开发文档
开放接口文档
收银台下单、API 下单、订单查询、退款、通知、签名和 WordPress 插件
内容与商户控制台保持同步。所有接口和签名都必须由商户服务端调用,不要在浏览器暴露商户 KEY。
notifyUrl 非必填;未配置回调时,商户必须通过查询订单接口主动确认支付结果。
当前支持:扫码支付、JSAPI 支付和 H5 支付;H5 支付仅个体工商户和企业主体支持。
主网关https://jpay.hzjianban.com
备用网关(支持 IPv6)https://api.jian-pay.com
易支付接口下单
兼容易支付常见的 submit.php、mapi.php 和 api.php 接口,适合已有易支付对接代码的商户。
接口说明
submit.php:兼容下单,成功时返回支付链接;浏览器访问时也支持直接跳转。mapi.php:兼容易支付 API 下单,返回易支付风格结果。api.php:通过act区分查单、退款和退款查询。
页面跳转支付 submit.php
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户号 | pid | 是 | String | JP26070612345678 | 易支付商户号,对应简付商户号 clientNo。 |
| 支付方式 | type | 是 | String | wxpay | 支持 wxpay、wx、wechat、alipay、ali、zfb;返回时统一为 wxpay 或 alipay。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080003 | 商户侧订单号,同一商户号下必须唯一;重复提交同一订单号会按幂等订单处理。 |
| 商品名称 | name | 是 | String | VIP会员 | 展示给用户看的商品或订单标题。 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元;最多 2 位小数,金额必须大于等于 0.01 元。 |
| 异步通知地址 | notify_url | 否 | String | https://example.com/pay/notify | 商户服务端接收支付结果通知的地址;不填则不会主动回调。 |
| 跳转通知地址 | return_url | 否 | String | https://example.com/pay/result | 用户支付完成后页面跳转地址,仅用于前端体验,订单最终状态以通知或查单为准。 |
| 业务扩展参数 | param | 否 | String | user_id=1001 | 商户自定义透传字段,支付通知和查单时原样返回。 |
| 请求时间戳 | timestamp | 否 | String | 1783500000 | 建议传秒级时间戳,便于商户侧排查请求链路;参与签名。 |
| 用户 IP 地址 | clientip | 否 | String | 192.168.1.100 | 兼容易支付常见字段;当前用于签名兼容,支付路由不依赖该字段。 |
| 设备类型 | device | 否 | String | pc | 兼容易支付常见字段,可传 pc、mobile、wechat 等;当前用于签名兼容。 |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | MD5 签名结果,小写;签名时排除 sign、sign_type 和空值字段。 |
| 签名类型 | sign_type | 是 | String | MD5 | 固定传 MD5。 |
响应参数
| 字段名 | 变量名 | 是否返回 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 支付跳转地址 | Location | 成功返回 | Header | https://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001 | submit.php 下单成功时返回 HTTP 302,浏览器会自动跳转到该地址。 |
| 状态码 | code | 失败返回 | Number | -1 | submit.php 下单失败时返回 JSON;-1 表示接口调用失败。 |
| 错误消息 | msg | 失败返回 | String | 签名验证失败 | 失败原因,例如签名错误、金额格式错误、商户号不存在等。 |
请求示例
API 下单 mapi.php
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户号 | pid | 是 | String | JP26070612345678 | 易支付商户号,对应简付商户号 clientNo。 |
| 支付方式 | type | 是 | String | wxpay | 支持 wxpay、wx、wechat、alipay、ali、zfb;返回时统一为 wxpay 或 alipay。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080003 | 商户侧订单号,同一商户号下必须唯一;重复提交同一订单号会按幂等订单处理。 |
| 商品名称 | name | 是 | String | VIP会员 | 展示给用户看的商品或订单标题。 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元;最多 2 位小数,金额必须大于等于 0.01 元。 |
| 异步通知地址 | notify_url | 否 | String | https://example.com/pay/notify | 商户服务端接收支付结果通知的地址;不填则不会主动回调。 |
| 跳转通知地址 | return_url | 否 | String | https://example.com/pay/result | 用户支付完成后页面跳转地址,仅用于前端体验,订单最终状态以通知或查单为准。 |
| 业务扩展参数 | param | 否 | String | user_id=1001 | 商户自定义透传字段,支付通知和查单时原样返回。 |
| 请求时间戳 | timestamp | 否 | String | 1783500000 | 建议传秒级时间戳,便于商户侧排查请求链路;参与签名。 |
| 用户 IP 地址 | clientip | 否 | String | 192.168.1.100 | 兼容易支付常见字段;当前用于签名兼容,支付路由不依赖该字段。 |
| 设备类型 | device | 否 | String | pc | 兼容易支付常见字段,可传 pc、mobile、wechat 等;当前用于签名兼容。 |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | MD5 签名结果,小写;签名时排除 sign、sign_type 和空值字段。 |
| 签名类型 | sign_type | 是 | String | MD5 | 固定传 MD5。 |
响应参数
| 字段名 | 变量名 | 是否返回 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | code | 是 | Number | 1 | 1 表示接口调用成功;失败时返回 -1。 |
| 返回消息 | msg | 是 | String | success | 成功固定为 success;失败时为错误原因。 |
| 平台订单号 | trade_no | 是 | String | PAY202607080001000001 | 简付平台订单号,后续查单、退款可使用该字段。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080004 | 商户请求中的 out_trade_no。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 当前订单所属商户号。 |
| 支付方式 | type | 是 | String | alipay | 返回 wxpay 或 alipay。 |
| 商品名称 | name | 是 | String | VIP会员 | 请求中的商品名称。 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元,保留两位小数。 |
| 收银台地址 | payurl | 是 | String | https://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001 | 可直接跳转的简付收银台地址。 |
| 二维码内容 | qrcode | 是 | String | weixin://wxpay/bizpayurl?... | 扫码支付二维码内容;微信收银台模式下可能返回收银台地址。 |
| 支付地址 | url | 是 | String | https://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001 | 兼容易支付字段,与 payurl 一致。 |
| 交易状态 | status | mapi.php 返回 | String | WAIT_BUYER_PAY | mapi.php 额外返回;可为 WAIT_BUYER_PAY、TRADE_SUCCESS、TRADE_FAILED、TRADE_CLOSED。 |
| 通道二维码 | qr_code | mapi.php 返回 | String | https://qr.alipay.com/xxx | mapi.php 额外返回;通道直接返回的二维码内容,没有时返回收银台地址。 |
| 拉起支付参数 | pay_info | 条件返回 | Object/String | {"appId":"wx..."} | JSAPI 等场景的拉起支付参数;扫码场景通常为空。 |
| 支付动作地址 | pay_action_url | 条件返回 | String | https://... | 从 pay_info 中解析出的可跳转支付地址;没有时为空。 |
请求示例
订单查询 api.php
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 接口动作 | act | 是 | String | order | 固定传 order;兼容 query、trade。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 易支付商户号,对应简付商户号 clientNo。 |
| 平台订单号 | trade_no | 二选一 | String | PAY202607080001000001 | 简付平台订单号;trade_no 和 out_trade_no 至少传一个。 |
| 商户订单号 | out_trade_no | 二选一 | String | P202607080004 | 商户订单号;trade_no 和 out_trade_no 至少传一个。 |
| 商户密钥 | key | key/sign 二选一 | String | 商户密钥 | api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。 |
| 签名字符串 | sign | key/sign 二选一 | String | 202cb962ac59075b964b07152d234b70 | MD5 签名结果,小写。 |
| 签名类型 | sign_type | 使用 sign 时必填 | String | MD5 | 固定传 MD5。 |
响应参数
| 字段名 | 变量名 | 是否返回 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | code | 是 | Number | 1 | 1 表示接口调用成功;失败时返回 -1。 |
| 返回消息 | msg | 是 | String | success | 成功固定为 success;失败时为错误原因。 |
| 平台订单号 | trade_no | 是 | String | PAY202607080001000001 | 简付平台订单号。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080004 | 商户订单号。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 当前订单所属商户号。 |
| 支付方式 | type | 是 | String | wxpay | 返回 wxpay 或 alipay。 |
| 商品名称 | name | 是 | String | VIP会员 | 订单商品名称。 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元,保留两位小数。 |
| 交易状态 | trade_status | 是 | String | TRADE_SUCCESS | WAIT_BUYER_PAY、TRADE_SUCCESS、TRADE_FAILED、TRADE_CLOSED。 |
| 状态码 | status | 是 | Number | 1 | 易支付兼容状态码:1 表示已支付,0 表示未支付或非成功状态。 |
| 状态说明 | status_text | 是 | String | 支付成功 | 订单状态中文说明。 |
| 业务扩展参数 | param | 否 | String | user_id=1001 | 下单时传入的 param,原样返回。 |
| 创建时间 | addtime | 是 | String | 2026-07-08 12:00:00 | 订单创建时间。 |
| 支付完成时间 | endtime | 条件返回 | String | 2026-07-08 12:30:00 | 支付成功时间;未支付时为空字符串。 |
请求示例
提交订单退款 api.php
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 接口动作 | act | 是 | String | refund_create | 固定传 refund_create;兼容 refund。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 易支付商户号,对应简付商户号 clientNo。 |
| 平台订单号 | trade_no | 二选一 | String | PAY202607080001000001 | 原支付订单的平台订单号;trade_no 和 out_trade_no 至少传一个。 |
| 商户订单号 | out_trade_no | 二选一 | String | P202607080004 | 原支付订单的商户订单号;trade_no 和 out_trade_no 至少传一个。 |
| 商户退款单号 | refund_no | 否 | String | R202607080001 | 商户侧退款单号;建议传入并保证同一商户号下唯一。 |
| 退款金额 | money | 是 | String | 0.10 | 单位:元;最多 2 位小数,不能超过订单可退金额。 |
| 退款原因 | reason | 否 | String | 用户申请退款 | 退款申请原因,不传默认订单退款。 |
| 商户密钥 | key | key/sign 二选一 | String | 商户密钥 | api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。 |
| 签名字符串 | sign | key/sign 二选一 | String | 202cb962ac59075b964b07152d234b70 | MD5 签名结果,小写。 |
| 签名类型 | sign_type | 使用 sign 时必填 | String | MD5 | 固定传 MD5。 |
响应参数
| 字段名 | 变量名 | 是否返回 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | code | 是 | Number | 1 | 1 表示接口调用成功;失败时返回 -1。 |
| 返回消息 | msg | 是 | String | success | 成功固定为 success;失败时为错误原因。 |
| 平台退款单号 | refund_id | 是 | String | RF202607080001000001 | 简付平台退款单号,后续退款查询可使用。 |
| 商户退款单号 | refund_no | 否 | String | R202607080001 | 商户传入的退款单号;未传时可能为空。 |
| 平台订单号 | trade_no | 是 | String | PAY202607080001000001 | 原支付订单的平台订单号。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080004 | 原支付订单的商户订单号。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 当前退款单所属商户号。 |
| 退款金额 | money | 是 | String | 0.10 | 单位:元,保留两位小数。 |
| 退款状态 | status | 是 | String | REFUND_PROCESSING | REFUND_PROCESSING、REFUND_SUCCESS、REFUND_FAILED。 |
| 状态说明 | status_text | 是 | String | 处理中 | 退款状态中文说明。 |
| 退款成功时间 | refund_time | 条件返回 | String | 2026-07-08 12:40:00 | 退款成功时返回;未成功时为空字符串。 |
| 创建时间 | addtime | 是 | String | 2026-07-08 12:35:00 | 退款单创建时间。 |
请求示例
退款查询 api.php
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 接口动作 | act | 是 | String | refund_query | 固定传 refund_query;兼容 query_refund。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 易支付商户号,对应简付商户号 clientNo。 |
| 平台退款单号 | refund_id | 二选一 | String | RF202607080001000001 | 简付平台退款单号;refund_id 和 refund_no 至少传一个。 |
| 商户退款单号 | refund_no | 二选一 | String | R202607080001 | 商户退款单号;refund_id 和 refund_no 至少传一个。 |
| 商户密钥 | key | key/sign 二选一 | String | 商户密钥 | api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。 |
| 签名字符串 | sign | key/sign 二选一 | String | 202cb962ac59075b964b07152d234b70 | MD5 签名结果,小写。 |
| 签名类型 | sign_type | 使用 sign 时必填 | String | MD5 | 固定传 MD5。 |
响应参数
| 字段名 | 变量名 | 是否返回 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | code | 是 | Number | 1 | 1 表示接口调用成功;失败时返回 -1。 |
| 返回消息 | msg | 是 | String | success | 成功固定为 success;失败时为错误原因。 |
| 平台退款单号 | refund_id | 是 | String | RF202607080001000001 | 简付平台退款单号,后续退款查询可使用。 |
| 商户退款单号 | refund_no | 否 | String | R202607080001 | 商户传入的退款单号;未传时可能为空。 |
| 平台订单号 | trade_no | 是 | String | PAY202607080001000001 | 原支付订单的平台订单号。 |
| 商户订单号 | out_trade_no | 是 | String | P202607080004 | 原支付订单的商户订单号。 |
| 商户号 | pid | 是 | String | JP26070612345678 | 当前退款单所属商户号。 |
| 退款金额 | money | 是 | String | 0.10 | 单位:元,保留两位小数。 |
| 退款状态 | status | 是 | String | REFUND_PROCESSING | REFUND_PROCESSING、REFUND_SUCCESS、REFUND_FAILED。 |
| 状态说明 | status_text | 是 | String | 处理中 | 退款状态中文说明。 |
| 退款成功时间 | refund_time | 条件返回 | String | 2026-07-08 12:40:00 | 退款成功时返回;未成功时为空字符串。 |
| 创建时间 | addtime | 是 | String | 2026-07-08 12:35:00 | 退款单创建时间。 |
请求示例
返回说明
submit.php适合表单提交或浏览器直接访问,成功时会 302 跳转到收银台支付地址;需要 JSON 返回时请使用mapi.php。sign计算时排除sign、sign_type和空值字段,其余入参按 ASCII 升序拼接后追加商户 KEY 做 MD5。key仅用于api.php查询、退款和退款查询;下单接口必须使用sign验签。
