开发文档

首页/开发文档

开放接口文档

收银台下单、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

接口地址/submit.php请求方式GET / POST返回格式成功 302 跳转;失败 JSON

请求参数

字段名变量名必填类型示例值描述
商户号pidStringJP26070612345678易支付商户号,对应简付商户号 clientNo。
支付方式typeStringwxpay支持 wxpay、wx、wechat、alipay、ali、zfb;返回时统一为 wxpay 或 alipay。
商户订单号out_trade_noStringP202607080003商户侧订单号,同一商户号下必须唯一;重复提交同一订单号会按幂等订单处理。
商品名称nameStringVIP会员展示给用户看的商品或订单标题。
商品金额moneyString1.00单位:元;最多 2 位小数,金额必须大于等于 0.01 元。
异步通知地址notify_urlStringhttps://example.com/pay/notify商户服务端接收支付结果通知的地址;不填则不会主动回调。
跳转通知地址return_urlStringhttps://example.com/pay/result用户支付完成后页面跳转地址,仅用于前端体验,订单最终状态以通知或查单为准。
业务扩展参数paramStringuser_id=1001商户自定义透传字段,支付通知和查单时原样返回。
请求时间戳timestampString1783500000建议传秒级时间戳,便于商户侧排查请求链路;参与签名。
用户 IP 地址clientipString192.168.1.100兼容易支付常见字段;当前用于签名兼容,支付路由不依赖该字段。
设备类型deviceStringpc兼容易支付常见字段,可传 pc、mobile、wechat 等;当前用于签名兼容。
签名字符串signString202cb962ac59075b964b07152d234b70MD5 签名结果,小写;签名时排除 sign、sign_type 和空值字段。
签名类型sign_typeStringMD5固定传 MD5。

响应参数

字段名变量名是否返回类型示例值描述
支付跳转地址Location成功返回Headerhttps://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001submit.php 下单成功时返回 HTTP 302,浏览器会自动跳转到该地址。
状态码code失败返回Number-1submit.php 下单失败时返回 JSON;-1 表示接口调用失败。
错误消息msg失败返回String签名验证失败失败原因,例如签名错误、金额格式错误、商户号不存在等。

请求示例

GET /submit.php?pid=JP26070612345678&type=wxpay&out_trade_no=P202607080003&name=%E6%B5%8B%E8%AF%95%E5%95%86%E5%93%81&money=1.00&notify_url=https%3A%2F%2Fexample.com%2Fpay%2Fnotify&return_url=https%3A%2F%2Fexample.com%2Fpay%2Fresult&param=user_id%3D1001&sign_type=MD5&sign=md5%E7%AD%BE%E5%90%8D

API 下单 mapi.php

接口地址/mapi.php请求方式GET / POST返回格式JSON

请求参数

字段名变量名必填类型示例值描述
商户号pidStringJP26070612345678易支付商户号,对应简付商户号 clientNo。
支付方式typeStringwxpay支持 wxpay、wx、wechat、alipay、ali、zfb;返回时统一为 wxpay 或 alipay。
商户订单号out_trade_noStringP202607080003商户侧订单号,同一商户号下必须唯一;重复提交同一订单号会按幂等订单处理。
商品名称nameStringVIP会员展示给用户看的商品或订单标题。
商品金额moneyString1.00单位:元;最多 2 位小数,金额必须大于等于 0.01 元。
异步通知地址notify_urlStringhttps://example.com/pay/notify商户服务端接收支付结果通知的地址;不填则不会主动回调。
跳转通知地址return_urlStringhttps://example.com/pay/result用户支付完成后页面跳转地址,仅用于前端体验,订单最终状态以通知或查单为准。
业务扩展参数paramStringuser_id=1001商户自定义透传字段,支付通知和查单时原样返回。
请求时间戳timestampString1783500000建议传秒级时间戳,便于商户侧排查请求链路;参与签名。
用户 IP 地址clientipString192.168.1.100兼容易支付常见字段;当前用于签名兼容,支付路由不依赖该字段。
设备类型deviceStringpc兼容易支付常见字段,可传 pc、mobile、wechat 等;当前用于签名兼容。
签名字符串signString202cb962ac59075b964b07152d234b70MD5 签名结果,小写;签名时排除 sign、sign_type 和空值字段。
签名类型sign_typeStringMD5固定传 MD5。

响应参数

字段名变量名是否返回类型示例值描述
返回状态码codeNumber11 表示接口调用成功;失败时返回 -1。
返回消息msgStringsuccess成功固定为 success;失败时为错误原因。
平台订单号trade_noStringPAY202607080001000001简付平台订单号,后续查单、退款可使用该字段。
商户订单号out_trade_noStringP202607080004商户请求中的 out_trade_no。
商户号pidStringJP26070612345678当前订单所属商户号。
支付方式typeStringalipay返回 wxpay 或 alipay。
商品名称nameStringVIP会员请求中的商品名称。
商品金额moneyString1.00单位:元,保留两位小数。
收银台地址payurlStringhttps://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001可直接跳转的简付收银台地址。
二维码内容qrcodeStringweixin://wxpay/bizpayurl?...扫码支付二维码内容;微信收银台模式下可能返回收银台地址。
支付地址urlStringhttps://jpay.hzjianban.com/#/pay?orderId=PAY202607080001000001兼容易支付字段,与 payurl 一致。
交易状态statusmapi.php 返回StringWAIT_BUYER_PAYmapi.php 额外返回;可为 WAIT_BUYER_PAY、TRADE_SUCCESS、TRADE_FAILED、TRADE_CLOSED。
通道二维码qr_codemapi.php 返回Stringhttps://qr.alipay.com/xxxmapi.php 额外返回;通道直接返回的二维码内容,没有时返回收银台地址。
拉起支付参数pay_info条件返回Object/String{"appId":"wx..."}JSAPI 等场景的拉起支付参数;扫码场景通常为空。
支付动作地址pay_action_url条件返回Stringhttps://...从 pay_info 中解析出的可跳转支付地址;没有时为空。

请求示例

POST /mapi.php
Content-Type: application/x-www-form-urlencoded

pid=JP26070612345678&type=alipay&out_trade_no=P202607080004&name=测试商品&money=1.00&notify_url=https://example.com/pay/notify&return_url=https://example.com/pay/result&param=user_id=1001&sign_type=MD5&sign=md5签名

订单查询 api.php

接口地址/api.php请求方式GET / POST返回格式JSON

请求参数

字段名变量名必填类型示例值描述
接口动作actStringorder固定传 order;兼容 query、trade。
商户号pidStringJP26070612345678易支付商户号,对应简付商户号 clientNo。
平台订单号trade_no二选一StringPAY202607080001000001简付平台订单号;trade_no 和 out_trade_no 至少传一个。
商户订单号out_trade_no二选一StringP202607080004商户订单号;trade_no 和 out_trade_no 至少传一个。
商户密钥keykey/sign 二选一String商户密钥api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。
签名字符串signkey/sign 二选一String202cb962ac59075b964b07152d234b70MD5 签名结果,小写。
签名类型sign_type使用 sign 时必填StringMD5固定传 MD5。

响应参数

字段名变量名是否返回类型示例值描述
返回状态码codeNumber11 表示接口调用成功;失败时返回 -1。
返回消息msgStringsuccess成功固定为 success;失败时为错误原因。
平台订单号trade_noStringPAY202607080001000001简付平台订单号。
商户订单号out_trade_noStringP202607080004商户订单号。
商户号pidStringJP26070612345678当前订单所属商户号。
支付方式typeStringwxpay返回 wxpay 或 alipay。
商品名称nameStringVIP会员订单商品名称。
商品金额moneyString1.00单位:元,保留两位小数。
交易状态trade_statusStringTRADE_SUCCESSWAIT_BUYER_PAY、TRADE_SUCCESS、TRADE_FAILED、TRADE_CLOSED。
状态码statusNumber1易支付兼容状态码:1 表示已支付,0 表示未支付或非成功状态。
状态说明status_textString支付成功订单状态中文说明。
业务扩展参数paramStringuser_id=1001下单时传入的 param,原样返回。
创建时间addtimeString2026-07-08 12:00:00订单创建时间。
支付完成时间endtime条件返回String2026-07-08 12:30:00支付成功时间;未支付时为空字符串。

请求示例

GET /api.php?act=order&pid=JP26070612345678&trade_no=PAY202607080001000001&key=商户密钥

提交订单退款 api.php

接口地址/api.php请求方式GET / POST返回格式JSON

请求参数

字段名变量名必填类型示例值描述
接口动作actStringrefund_create固定传 refund_create;兼容 refund。
商户号pidStringJP26070612345678易支付商户号,对应简付商户号 clientNo。
平台订单号trade_no二选一StringPAY202607080001000001原支付订单的平台订单号;trade_no 和 out_trade_no 至少传一个。
商户订单号out_trade_no二选一StringP202607080004原支付订单的商户订单号;trade_no 和 out_trade_no 至少传一个。
商户退款单号refund_noStringR202607080001商户侧退款单号;建议传入并保证同一商户号下唯一。
退款金额moneyString0.10单位:元;最多 2 位小数,不能超过订单可退金额。
退款原因reasonString用户申请退款退款申请原因,不传默认订单退款。
商户密钥keykey/sign 二选一String商户密钥api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。
签名字符串signkey/sign 二选一String202cb962ac59075b964b07152d234b70MD5 签名结果,小写。
签名类型sign_type使用 sign 时必填StringMD5固定传 MD5。

响应参数

字段名变量名是否返回类型示例值描述
返回状态码codeNumber11 表示接口调用成功;失败时返回 -1。
返回消息msgStringsuccess成功固定为 success;失败时为错误原因。
平台退款单号refund_idStringRF202607080001000001简付平台退款单号,后续退款查询可使用。
商户退款单号refund_noStringR202607080001商户传入的退款单号;未传时可能为空。
平台订单号trade_noStringPAY202607080001000001原支付订单的平台订单号。
商户订单号out_trade_noStringP202607080004原支付订单的商户订单号。
商户号pidStringJP26070612345678当前退款单所属商户号。
退款金额moneyString0.10单位:元,保留两位小数。
退款状态statusStringREFUND_PROCESSINGREFUND_PROCESSING、REFUND_SUCCESS、REFUND_FAILED。
状态说明status_textString处理中退款状态中文说明。
退款成功时间refund_time条件返回String2026-07-08 12:40:00退款成功时返回;未成功时为空字符串。
创建时间addtimeString2026-07-08 12:35:00退款单创建时间。

请求示例

POST /api.php?act=refund_create
Content-Type: application/x-www-form-urlencoded

pid=JP26070612345678&trade_no=PAY202607080001000001&refund_no=R202607080001&money=0.10&key=商户密钥

退款查询 api.php

接口地址/api.php请求方式GET / POST返回格式JSON

请求参数

字段名变量名必填类型示例值描述
接口动作actStringrefund_query固定传 refund_query;兼容 query_refund。
商户号pidStringJP26070612345678易支付商户号,对应简付商户号 clientNo。
平台退款单号refund_id二选一StringRF202607080001000001简付平台退款单号;refund_id 和 refund_no 至少传一个。
商户退款单号refund_no二选一StringR202607080001商户退款单号;refund_id 和 refund_no 至少传一个。
商户密钥keykey/sign 二选一String商户密钥api.php 兼容方式,可直接传商户 KEY;如果不传 key,则必须传 sign。
签名字符串signkey/sign 二选一String202cb962ac59075b964b07152d234b70MD5 签名结果,小写。
签名类型sign_type使用 sign 时必填StringMD5固定传 MD5。

响应参数

字段名变量名是否返回类型示例值描述
返回状态码codeNumber11 表示接口调用成功;失败时返回 -1。
返回消息msgStringsuccess成功固定为 success;失败时为错误原因。
平台退款单号refund_idStringRF202607080001000001简付平台退款单号,后续退款查询可使用。
商户退款单号refund_noStringR202607080001商户传入的退款单号;未传时可能为空。
平台订单号trade_noStringPAY202607080001000001原支付订单的平台订单号。
商户订单号out_trade_noStringP202607080004原支付订单的商户订单号。
商户号pidStringJP26070612345678当前退款单所属商户号。
退款金额moneyString0.10单位:元,保留两位小数。
退款状态statusStringREFUND_PROCESSINGREFUND_PROCESSING、REFUND_SUCCESS、REFUND_FAILED。
状态说明status_textString处理中退款状态中文说明。
退款成功时间refund_time条件返回String2026-07-08 12:40:00退款成功时返回;未成功时为空字符串。
创建时间addtimeString2026-07-08 12:35:00退款单创建时间。

请求示例

POST /api.php?act=refund_query
Content-Type: application/x-www-form-urlencoded

pid=JP26070612345678&refund_no=R202607080001&key=商户密钥
返回说明
  • submit.php 适合表单提交或浏览器直接访问,成功时会 302 跳转到收银台支付地址;需要 JSON 返回时请使用 mapi.php
  • sign 计算时排除 signsign_type 和空值字段,其余入参按 ASCII 升序拼接后追加商户 KEY 做 MD5。
  • key 仅用于 api.php 查询、退款和退款查询;下单接口必须使用 sign 验签。