From 3547d08303eba7daa84f3f413892284d859353c3 Mon Sep 17 00:00:00 2001 From: kongyuebin <447206051@qq.com> Date: Thu, 19 Dec 2019 15:04:52 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9A=82=E6=97=B6=E4=B8=8D=E5=85=AC=E5=BC=80?= =?UTF-8?q?=E5=AF=B9=E6=8E=A5=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- jhagent/views/api_doc/pay_doc.html | 1614 ------------------------- jhmerchant/views/api_doc/pay_doc.html | 1614 ------------------------- 2 files changed, 3228 deletions(-) delete mode 100644 jhagent/views/api_doc/pay_doc.html delete mode 100644 jhmerchant/views/api_doc/pay_doc.html diff --git a/jhagent/views/api_doc/pay_doc.html b/jhagent/views/api_doc/pay_doc.html deleted file mode 100644 index 1f37ada..0000000 --- a/jhagent/views/api_doc/pay_doc.html +++ /dev/null @@ -1,1614 +0,0 @@ - - - - - 对接文档 - - - -
商户对接文档(所有字段均传字符串类型)
-
- -
-
-

扫码支付

-

1:请求地址

- http://localhost:10081/gateway/scan -

2:商户请求数据,表单提交

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode扫码类型变长8支付宝:ALI_SCAN
微 信:WEIXIN_SCAN
QQ钱包:QQ_SCAN
百度扫码:BAIDU_SCAN
银联扫码:UNION_SCAN
京东扫码:JD_SCAN -
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notifyUrl为必填,否则无法将支付结果通知到商户网站。
07returnUrl支付成功后跳转地址变长128支付成功后,如果上游的系统允许商户跳转自带的成功页面
不一定会按照填写的地址进行跳转
08payKey支付key固定长32商户支付标识
10sign签名固定长32参见《签名与验签》
-

3:响应数据列表,JSON格式

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位
例如:1.00(1元),0.01(1分)
03payKey支付key固定长32商户支付标识
04payURL二维码URL变长128商户可以用改链接地址,渲染成适配的扫码页面
05statusCode状态码固定长200(订单生成成功)
其他值(失败)
06msg信息无固定长度一些附带说明
07sign签名固定长32参见《签名与验签》
-

4:成功样例

-
- {
-  "orderNo": "1507966197960",
-  "sign": "0D3F39874AF0B6F07C4AB5230FC7E55F",
-  "orderPrice": "0.01",
-  "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-  "payURL": "https://qr.alipay.com/bax04483swjy46gkbvms604e",
-  "statusCode": "00",
-  "msg":"请求成功"
- }
- -

5:失败样例

- - {
-  "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-  "statusCode": "01",
-  "msg":"获取二维码失败"
- }
-
-
-
-
-
-

H5支付

-

1:请求地址

- http://localhost:10081/gateway/h5 -

2:H5产品说明

-

H5应用产品都是在移动端使用,用户点击支付按钮,页面会自动拉起相应的APP。例如:拉起微信进行支付、拉起支付宝、拉起QQ等。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8微信 H5 支付: WEIXIN_H5
支付宝H5支付: ALI_WAP
QQ H5 支付: QQ_H5
银联H5支付: UNION_H5 -
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08sceneType场景类型变长10场景类型
IOS:0
Android:1
Wap:2
09appNameAPP名称变长128场景类型sceneType=0、1时必填
例如:王者荣耀
否则不填
10bundleId绑定ID变长128场景类型sceneType=0时必填
例如:com.tencent.wzryIOS
否则不填
11packageName包名变长128场景类型sceneType=1时必填
例如:com.tencent.tmgp.sgame
否则不填
12wapUrlWAP网站URL变长128场景类型sceneType=2时必填
例如:https://pay.qq.com
否则不填
14payKey支付key固定长32商户支付标识
16sign签名固定长32参见《签名与验签》
-

4:H5支付产品,无数据返回。商户在提交数据后,会自动拉起APP。

-
-
-

收银台支付

-

1:请求地址

- http://localhost:10081/gateway/syt -

2:产品说明

-

收银台是上游提供完整的用户交互界面,无需商户自己渲染交互页面。因此收银台没有参数返回。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8微信收银台:WEIXIN_SYT
QQ钱包收银台:QQ_SYT
银联收银台:UNION_SYT
支付宝收银台:ALI_SYT
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08payKey支付key固定长32商户支付标识
10sign签名固定长32参见《签名与验签》
-
-
-
-
-

快捷支付

-

1:请求地址

- http://localhost:10081/gateway/fast -

2:产品说明

-

快捷支付的用户交互页面,由上游提供,故此商户发送请求数据后,没有数据返回。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8快捷支付:SCAN_FAST
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08returnUrl页面跳转同步通知页面路径变长128 - 交易完成后,快付支付平台会按照此地址将用户的交易结果页面重定向到商户网站。为保证商户能收到交易的结果,则必须至少提交ret_url,notify_url其中之一,前端支付请求必须传递returnUrl,否则无法正常返回商户网站 -
09payKey支付key固定长32商户支付标识
10bankName银行编号固定长10详细参见:附录
11payType支付卡种固定长2借记卡:01
贷记卡:02
暂时只支持借记卡
12certificateNo身份证变长20开户人身份证
12accountNo银行卡号变长20银行卡的卡号
12accountName姓名变长20持卡者姓名
12mobileNo手机号码变长20跟银行卡绑定
14sign签名固定长32参见《签名与验签》
-
-
-
-
-

支付回调(post方式)

-

1:说明

-

客户支付成功后,平台向商户发起异步通知,通知地址为下单请求中传递给平台的notifyUrl地址(建议在接收到回调后验》证签名和判断状态)。 - 商户程序处理完业务逻辑后,需要返回success到平台,平台就不会再发起通知了; 否则会按照这个规律发起通知

-

2:回调机制

- - - - - - - - - - - - - - - - - - - - - - - - - -
第N次间隔时间(单位分钟)
第1次0min
第2次2min
第3次5min
第4次15min
第5次30min
-

3:商户回调参数

- - - - - - - - - - - - - - - - - - - - - - - - - - {{/* - - */}} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
02showPrice展示付款金额变长13是人民币,且以元为单位。展示在用户面前的金额。
02factPrice实际付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
03orderTime商户订单日期定长14商户生成订单的日期,格式yyyyMMddHHmmss
04trxNo平台交易流水号固定长20
05statusCode状态码固定长200(查询操作成功)
其他值(失败)
06tradeStatus交易状态变长 20详见《交易状态说明》
08payKey支付key固定长32商户支付标识
09sign签名固定长32参见《签名与验签》
-
-
-
-
-

支付结果查询

-

1:请求地址

- http://47.101.3.15/gateway/order/query -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02payKey支付key固定长32商户支付标识
03sign签名固定长32参见《签名与验签》
-

3:响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
02factPrice实际付款金额变长13是人民币,且以元为单位。
03orderTime商户订单日期定长14商户生成订单的日期,格式yyyyMMddHHmmss
04trxNo平台交易流水号固定长20
05statusCode状态码固定长200(查询操作成功)
其他值(失败)
06tradeStatus交易状态变长 20详见《交易状态说明》
08payKey支付key固定长32商户支付标识
09sign签名固定长32参见《签名与验签》
-

4:订单查询成功样例

-
- {
-   "orderNo": "1508055453731",
-   "orderTime": "20171015162249",
-   "trxNo": "77772017101510000722",
-   "tradeStatus": "wait",
-   "sign": "8E3DC89AB06B0E6361D7D2CDF164456C",
-   "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-   "orderPrice": "0.01",
-   "factPrice": "0.01",
-   "statusCode": "00"
- }
- -

5:订单查询失败样例

- - {
-   "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-   "statusCode": "01",
-   "msg": "商户不存在"
- }
-
-
-
-
-
-

支付状态说明

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号枚举名称说明备注
01wait交易创建,等待买家付款
02success交易成功,不能再次进行交易
03cancel交易撤销
04fail交易失败失败可能风控引起
-
-
-
-
-

代付接口

-

1:请求地址

- http://47.101.3.15/gateway/payfor -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02realname持卡人姓名变长60持卡人真实姓名
03cardNo卡号变长30代付卡卡号
04bankCode银行编码变长10银行编码,文档最后附有
05accType开户账号类型固定长201 -- 对公帐户
02 --对私借记卡
06province开户行所在省份变长14开户行所在省份
07city开户行所在城市变长30开户行所在城市
08bankAccountAddress开户行全称变长32开户行全称
09amount代付金额变长12订单金额,以元为单位(保留2位小数 100.00)
10moblieNo银行预留手机号码变长15银行预留手机号码
11merchantOrderId商户订单号变长32商户订单号
12sign签名固定长32使用商户key对报文签名后的值
-

3:响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01resultCode返回码固定长200 -- 受理成功
01 -- 其它
02resultMsg商户订单号变长256返回码信息提示
03merchantOrderId卡号变长32商户系统的订单号resultCode为00时必填
其余可不填
04settAmount代付金额变长10代付金额 ,以元为单位resultCode为00时必填
其余可不填
08sign签名固定长32使用商户key对报文签名后的值
-

4:成功返回样例

- - {
-   "settAmount":"15,
-   "resultCode":"00",
-   "sign":"2509743B7C6A12011A7BAD16F7A78F8F",
-   "merchantOrderId":"1522654509571",
-   "resultMsg":"代付订单已生成"
- }
-
-

5:失败样例

- - {
-   "resultCode":"01",
-   "resultMsg":"accType类型错误"
- }
-
-
-
-

代付结果查询

-

1:代付查询地址

- http://47.101.3.15/gateway/payfor/query -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02timestamp时间戳固定长10unix时间戳
03merchantOrderId商户订单号变长32商户订单号
04sign签名固定长32使用商户key对报文签名后的值
-

3:响应数据,JSON格式

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
02resultMsg商户订单号变长256返回码信息提示
03merchantOrderId卡号变长32商户系统的订单号
04settAmount代付金额变长32代付金额 ,以元为单位settStatus为 00 时,必须
06settFee手续费变长10代付手续费settStatus为 00 时,必须
07settStatus代付结果变长3000 -- 打款成功
01-- 打款失败
02 -- 打款中
03 -- 查询失败
08sign签名变长30使用商户key对报文签名后的值
-

4:成功样例

- - {
-   "resultMsg":"打款成功",
-   "merchantOrderId":"123456",
-   "settAmount":"10000.00",
-   "settFee":"2.00",
-   "settStatus":"00",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-

5:失败样例

- - {
-   "resultMsg":"查询失败",
-   "settStatus":"03",
-   "merchantOrderId":"123456",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-
-
-
-
-

账户余额查询

-

请求地址

- http://47.101.3.15/gateway/balance -

商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02timestamp时间戳固定长10unix时间戳
04sign签名固定长32使用商户key对报文签名后的值
-

响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01resultCode返回码固定长200 -- 成功
其它 -- 失败
02balance账户余额变长12账户总余额
03availableAmount可用余额变长12账户可结算余额resultCode为00时必填
其余可不填
05freezeAmount冻结金额变长12账户可结算余额resultCode为00时必填
其余可不填
06waitAmount待结算金额变长12账户可结算余额resultCode为00时必填
其余可不填
07loanAmount押款金额变长12账户可结算余额resultCode为00时必填
其余可不填
08payforAmount在出款金额变长12账户可结算余额resultCode为00时必填
其余可不填
09resultMsg返回码描述信息变长256返回码信息提示resultCode为00时必填
其余可不填
10sign签名变长30使用商户key对报文签名后的值resultCode为00时必填
其余可不填
-

成功样例

- - {
-   "resultCode":"00",
-   "balance":"25000.00",
-   "availableAmount":"5000.00",
-   "freezeAmount":"5000.00",
-   "waitAmount":"5000.00",
-   "loanAmount":"5000.00",
-   "payforAmount":"5000.00",
-   "resultMsg":"查询成功",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-

失败样例

- - {
-   "resultCode":"-1",
-   "resultMsg":"查询失败"
- }
-
-
- - -
-

签名与验签

-

1:签名算法

-

在请求参数列表中,除去sign参数外,其它必填的字段均参加签名。

-

参与签名的键值对,根据key值按照acsii码从小到大进行排序,每个键值对之间用"&"进行连接。

-

在拼接完得到的字符串尾部,再将支付密钥(paySecret)拼接上。

-

最后将得到的待签名字符串进行MD5加密,将字母全部转为大写。

-

2:格式样例,需要签名的字符串

- - waitSign: a=xxxxxxx&b=xxxxxxx&c=xxxxx&d=xxxxxx&e=xxxxx&f=xxxxxx&paySecret=xxxx - -

3:得到的签名字符串

- - sign=70387FEBC8487EFFBE93511299BB30A7 - -
-
-
-
-

银行编码

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
支付银行描述
ICBC中国工商银行
ABC中国农业银行
CCB中国建设银行
BOC中国银行
COMM交通银行
PSBC中国邮政储蓄银行
CMB招商银行
CMBC民生银行
SPDB上海浦东发展银行
CITIC中信银行
HXB华夏银行
CIB兴业银行
PINGANBANK平安银行
CZB浙商银行
HFB恒丰银行
GDB广发银行
CEB光大银行
CBHB渤海银行
CSCB长沙银行
-
-
-
-
-

常见问题解答

-

1:支付key和商户密钥怎么获取

-

答:这两个字段在开户成功后,相关运营人员会将两者发送给商户。请求商户妥善保管。

-

2:请求协议是支持get还是post

-

答:同时支持get和post。

-
-
-
- - - \ No newline at end of file diff --git a/jhmerchant/views/api_doc/pay_doc.html b/jhmerchant/views/api_doc/pay_doc.html deleted file mode 100644 index b03c2c9..0000000 --- a/jhmerchant/views/api_doc/pay_doc.html +++ /dev/null @@ -1,1614 +0,0 @@ - - - - - 对接文档 - - - -
商户对接文档(所有字段均传字符串类型)
-
- -
-
-

扫码支付

-

1:请求地址

- http://localhost:10081/gateway/scan -

2:商户请求数据,表单提交

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode扫码类型变长8支付宝:ALI_SCAN
微 信:WEIXIN_SCAN
QQ钱包:QQ_SCAN
百度扫码:BAIDU_SCAN
银联扫码:UNION_SCAN
京东扫码:JD_SCAN -
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notifyUrl为必填,否则无法将支付结果通知到商户网站。
07returnUrl支付成功后跳转地址变长128支付成功后,如果上游的系统允许商户跳转自带的成功页面
不一定会按照填写的地址进行跳转
08payKey支付key固定长32商户支付标识
10sign签名固定长32参见《签名与验签》
-

3:响应数据列表,JSON格式

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位
例如:1.00(1元),0.01(1分)
03payKey支付key固定长32商户支付标识
04payURL二维码URL变长128商户可以用改链接地址,渲染成适配的扫码页面
05statusCode状态码固定长200(订单生成成功)
其他值(失败)
06msg信息无固定长度一些附带说明
07sign签名固定长32参见《签名与验签》
-

4:成功样例

-
- {
-  "orderNo": "1507966197960",
-  "sign": "0D3F39874AF0B6F07C4AB5230FC7E55F",
-  "orderPrice": "0.01",
-  "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-  "payURL": "https://qr.alipay.com/bax04483swjy46gkbvms604e",
-  "statusCode": "00",
-  "msg":"请求成功"
- }
- -

5:失败样例

- - {
-  "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-  "statusCode": "01",
-  "msg":"获取二维码失败"
- }
-
-
-
-
-
-

H5支付

-

1:请求地址

- http://localhost:10081/gateway/h5 -

2:H5产品说明

-

H5应用产品都是在移动端使用,用户点击支付按钮,页面会自动拉起相应的APP。例如:拉起微信进行支付、拉起支付宝、拉起QQ等。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8微信 H5 支付: WEIXIN_H5
支付宝H5支付: ALI_WAP
QQ H5 支付: QQ_H5
银联H5支付: UNION_H5 -
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08sceneType场景类型变长10场景类型
IOS:0
Android:1
Wap:2
09appNameAPP名称变长128场景类型sceneType=0、1时必填
例如:王者荣耀
否则不填
10bundleId绑定ID变长128场景类型sceneType=0时必填
例如:com.tencent.wzryIOS
否则不填
11packageName包名变长128场景类型sceneType=1时必填
例如:com.tencent.tmgp.sgame
否则不填
12wapUrlWAP网站URL变长128场景类型sceneType=2时必填
例如:https://pay.qq.com
否则不填
14payKey支付key固定长32商户支付标识
16sign签名固定长32参见《签名与验签》
-

4:H5支付产品,无数据返回。商户在提交数据后,会自动拉起APP。

-
-
-

收银台支付

-

1:请求地址

- http://localhost:10081/gateway/syt -

2:产品说明

-

收银台是上游提供完整的用户交互界面,无需商户自己渲染交互页面。因此收银台没有参数返回。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8微信收银台:WEIXIN_SYT
QQ钱包收银台:QQ_SYT
银联收银台:UNION_SYT
支付宝收银台:ALI_SYT
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08payKey支付key固定长32商户支付标识
10sign签名固定长32参见《签名与验签》
-
-
-
-
-

快捷支付

-

1:请求地址

- http://localhost:10081/gateway/fast -

2:产品说明

-

快捷支付的用户交互页面,由上游提供,故此商户发送请求数据后,没有数据返回。

-

3:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长30订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02productName商品描述信息变长64
03orderPeriod订单过期时间变长4订单过期时间,单位:小时
04orderPrice付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
05payWayCode支付类型变长8快捷支付:SCAN_FAST
06osType支付设备系统类型变长2PC端:0
移动端:1
07notifyUrl服务器异步通知页面路径变长128交易完成后,快付支付平台会按照此地址将交易结果以后台的方式发送到商户网站。
在后端支付请求中,notify_url为必填,否则无法将支付结果通知到商户网站。
08returnUrl页面跳转同步通知页面路径变长128 - 交易完成后,快付支付平台会按照此地址将用户的交易结果页面重定向到商户网站。为保证商户能收到交易的结果,则必须至少提交ret_url,notify_url其中之一,前端支付请求必须传递returnUrl,否则无法正常返回商户网站 -
09payKey支付key固定长32商户支付标识
10bankName银行编号固定长10详细参见:附录
11payType支付卡种固定长2借记卡:01
贷记卡:02
暂时只支持借记卡
12certificateNo身份证变长20开户人身份证
12accountNo银行卡号变长20银行卡的卡号
12accountName姓名变长20持卡者姓名
12mobileNo手机号码变长20跟银行卡绑定
14sign签名固定长32参见《签名与验签》
-
-
-
-
-

支付回调(post方式)

-

1:说明

-

客户支付成功后,平台向商户发起异步通知,通知地址为下单请求中传递给平台的notifyUrl地址(建议在接收到回调后验》证签名和判断状态)。 - 商户程序处理完业务逻辑后,需要返回success到平台,平台就不会再发起通知了; 否则会按照这个规律发起通知

-

2:回调机制

- - - - - - - - - - - - - - - - - - - - - - - - - -
第N次间隔时间(单位分钟)
第1次0min
第2次2min
第3次5min
第4次15min
第5次30min
-

3:商户回调参数

- - - - - - - - - - - - - - - - - - - - - - - - - - {{/* - - */}} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
02showPrice展示付款金额变长13是人民币,且以元为单位。展示在用户面前的金额。
02factPrice实际付款金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
03orderTime商户订单日期定长14商户生成订单的日期,格式yyyyMMddHHmmss
04trxNo平台交易流水号固定长20
05statusCode状态码固定长200(查询操作成功)
其他值(失败)
06tradeStatus交易状态变长 20详见《交易状态说明》
08payKey支付key固定长32商户支付标识
09sign签名固定长32参见《签名与验签》
-
-
-
-
-

支付结果查询

-

1:请求地址

- http://47.101.3.15/gateway/order/query -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02payKey支付key固定长32商户支付标识
03sign签名固定长32参见《签名与验签》
-

3:响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01orderNo商户唯一订单号变长32订单号码支持数字、英文字母、-、_、*、+、#,其他字符将不支持
02orderPrice订单金额变长13是人民币,且以元为单位,例如:1.00(1元),0.01(1分)
02factPrice实际付款金额变长13是人民币,且以元为单位。
03orderTime商户订单日期定长14商户生成订单的日期,格式yyyyMMddHHmmss
04trxNo平台交易流水号固定长20
05statusCode状态码固定长200(查询操作成功)
其他值(失败)
06tradeStatus交易状态变长 20详见《交易状态说明》
08payKey支付key固定长32商户支付标识
09sign签名固定长32参见《签名与验签》
-

4:订单查询成功样例

-
- {
-   "orderNo": "1508055453731",
-   "orderTime": "20171015162249",
-   "trxNo": "77772017101510000722",
-   "tradeStatus": "wait",
-   "sign": "8E3DC89AB06B0E6361D7D2CDF164456C",
-   "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-   "orderPrice": "0.01",
-   "factPrice": "0.01",
-   "statusCode": "00"
- }
- -

5:订单查询失败样例

- - {
-   "payKey": "9ae9ef6d094d4de69bb5dc19abf48ec9",
-   "statusCode": "01",
-   "msg": "商户不存在"
- }
-
-
-
-
-
-

支付状态说明

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号枚举名称说明备注
01wait交易创建,等待买家付款
02success交易成功,不能再次进行交易
03cancel交易撤销
04fail交易失败失败可能风控引起
-
-
-
-
-

代付接口

-

1:请求地址

- http://47.101.3.15/gateway/payfor -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02realname持卡人姓名变长60持卡人真实姓名
03cardNo卡号变长30代付卡卡号
04bankCode银行编码变长10银行编码,文档最后附有
05accType开户账号类型固定长201 -- 对公帐户
02 --对私借记卡
06province开户行所在省份变长14开户行所在省份
07city开户行所在城市变长30开户行所在城市
08bankAccountAddress开户行全称变长32开户行全称
09amount代付金额变长12订单金额,以元为单位(保留2位小数 100.00)
10moblieNo银行预留手机号码变长15银行预留手机号码
11merchantOrderId商户订单号变长32商户订单号
12sign签名固定长32使用商户key对报文签名后的值
-

3:响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01resultCode返回码固定长200 -- 受理成功
01 -- 其它
02resultMsg商户订单号变长256返回码信息提示
03merchantOrderId卡号变长32商户系统的订单号resultCode为00时必填
其余可不填
04settAmount代付金额变长10代付金额 ,以元为单位resultCode为00时必填
其余可不填
08sign签名固定长32使用商户key对报文签名后的值
-

4:成功返回样例

- - {
-   "settAmount":"15,
-   "resultCode":"00",
-   "sign":"2509743B7C6A12011A7BAD16F7A78F8F",
-   "merchantOrderId":"1522654509571",
-   "resultMsg":"代付订单已生成"
- }
-
-

5:失败样例

- - {
-   "resultCode":"01",
-   "resultMsg":"accType类型错误"
- }
-
-
- -
-

代付结果查询

-

1:代付查询地址

- http://47.101.3.15/gateway/payfor/query -

2:商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02timestamp时间戳固定长10unix时间戳
03merchantOrderId商户订单号变长32商户订单号
04sign签名固定长32使用商户key对报文签名后的值
-

3:响应数据,JSON格式

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
02resultMsg商户订单号变长256返回码信息提示
03merchantOrderId卡号变长32商户系统的订单号
04settAmount代付金额变长32代付金额 ,以元为单位settStatus为 00 时,必须
06settFee手续费变长10代付手续费settStatus为 00 时,必须
07settStatus代付结果变长3000 -- 打款成功
01-- 打款失败
02 -- 打款中
03 -- 查询失败
08sign签名变长30使用商户key对报文签名后的值
-

4:成功样例

- - {
-   "resultMsg":"打款成功",
-   "merchantOrderId":"123456",
-   "settAmount":"10000.00",
-   "settFee":"2.00",
-   "settStatus":"00",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-

5:失败样例

- - {
-   "resultMsg":"查询失败",
-   "settStatus":"03",
-   "merchantOrderId":"123456",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-
-
-
-
-

账户余额查询

-

请求地址

- http://47.101.3.15/gateway/balance -

商户请求数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01merchantKey商户key变长32商户key,可找商务获取
02timestamp时间戳固定长10unix时间戳
04sign签名固定长32使用商户key对报文签名后的值
-

响应数据

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
序号字段名称长度说明是否必填
01resultCode返回码固定长200 -- 成功
其它 -- 失败
02balance账户余额变长12账户总余额
03availableAmount可用余额变长12账户可结算余额resultCode为00时必填
其余可不填
05freezeAmount冻结金额变长12账户可结算余额resultCode为00时必填
其余可不填
06waitAmount待结算金额变长12账户可结算余额resultCode为00时必填
其余可不填
07loanAmount押款金额变长12账户可结算余额resultCode为00时必填
其余可不填
08payforAmount在出款金额变长12账户可结算余额resultCode为00时必填
其余可不填
09resultMsg返回码描述信息变长256返回码信息提示resultCode为00时必填
其余可不填
10sign签名变长30使用商户key对报文签名后的值resultCode为00时必填
其余可不填
-

成功样例

- - {
-   "resultCode":"00",
-   "balance":"25000.00",
-   "availableAmount":"5000.00",
-   "freezeAmount":"5000.00",
-   "waitAmount":"5000.00",
-   "loanAmount":"5000.00",
-   "payforAmount":"5000.00",
-   "resultMsg":"查询成功",
-   "sign":"70387FEBC8487EFFBE93511299BB30A7"
- }
-
-

失败样例

- - {
-   "resultCode":"-1",
-   "resultMsg":"查询失败"
- }
-
-
- - -
-

签名与验签

-

1:签名算法

-

在请求参数列表中,除去sign参数外,其它必填的字段均参加签名。

-

参与签名的键值对,根据key值按照acsii码从小到大进行排序,每个键值对之间用"&"进行连接。

-

在拼接完得到的字符串尾部,再将支付密钥(paySecret)拼接上。

-

最后将得到的待签名字符串进行MD5加密,将字母全部转为大写。

-

2:格式样例,需要签名的字符串

- - waitSign: a=xxxxxxx&b=xxxxxxx&c=xxxxx&d=xxxxxx&e=xxxxx&f=xxxxxx&paySecret=xxxx - -

3:得到的签名字符串

- - sign=70387FEBC8487EFFBE93511299BB30A7 - -
-
-
-
-

银行编码

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
支付银行描述
ICBC中国工商银行
ABC中国农业银行
CCB中国建设银行
BOC中国银行
COMM交通银行
PSBC中国邮政储蓄银行
CMB招商银行
CMBC民生银行
SPDB上海浦东发展银行
CITIC中信银行
HXB华夏银行
CIB兴业银行
PINGANBANK平安银行
CZB浙商银行
HFB恒丰银行
GDB广发银行
CEB光大银行
CBHB渤海银行
CSCB长沙银行
-
-
-
-
-

常见问题解答

-

1:支付key和商户密钥怎么获取

-

答:这两个字段在开户成功后,相关运营人员会将两者发送给商户。请求商户妥善保管。

-

2:请求协议是支持get还是post

-

答:同时支持get和post。

-
-
-
- - - \ No newline at end of file