产品平台报文接口规范.docx
《产品平台报文接口规范.docx》由会员分享，可在线阅读，更多相关《产品平台报文接口规范.docx（38页珍藏版）》请在冰点文库上搜索。
产品平台报文接口规范
产品平台报文接口规范
11 总体技术方案
11.1 通讯方式
所有报文域以JSON报文格式，发送到汇宜产品平台。
前端发送交易结果同步响应给商户，如超时仍未得到交易响应，商户可通过发起交易查询获取交易处理结果。
交易状态查询类交易，交易结果同步响应给商户。
11.2 符号约定
表1符号约定
符号
含义
数据元数值符号
M
必须填写的域
C
某条件成立时必须填写的域
O
受理方和发卡方自选填写的域
R
必须与先前报文中对应域的值相同的域
11.3 签名机制
11.3.1.1 报文的签名机制
对于报文的签名处理机制如下：
首先，对报文中msg_body对象域转换成json字符串，再使用机构RSA私钥证书对该串做签名操作（签名时算法选择SHA-1）。
最后，对签名做Base64编码，将编码后的签名串放在签名（signature）字段中，将报文放在body中，以json方式发送给汇宜产品平台。
11.3.1.2 报文的验签机制
对于报文的验签处理机制如下：
首先，取出msg_body域值作为待签名串。
其次，使用汇宜机构RSA公钥证书对待签名串和报文中的签名信息做签名验证操作。
报文示例：
{"version":
"1.0.0","encoding":
"UTF-8","signature":
"x/nSIrz/lJnVH4Nv+zOB/nGrkJ0r0nDZIMis1UqIxVG/xNMHYN7dqpj/qBl1uFt8O0ko813SC8e8Lnc7W1K/AR01IEn8Lzq1WYnx0qmDIwSrrsQMuRo1D0agOuNlPaL3weKKBAGdUdsahASPURKZ1sXsLP/43r+3ufPvZitnL575xPLKQaZO7xq6ien7ZW4tb0VGKcj06IQ9AA5zOFANTweIPao+7ttqKysOEF2PY/y0NSN/hFQ0P7Me7XobNXzyZW/kMir/Sa447xwnAs2tkrDQm4h4icNEASFZZltXp1Xwk24obwl4Uc11PnTG2IxvQwZmyeP4sRJe24y6FWjgwA==","sign_method":
"01","msg_body":
"{\"ins_id_cd\":
\"\",\"prod_cd\":
\"1151\",\"biz_cd\":
\"\",\"mcht_cd\":
\"9969\",\"tran_dt_tm\":
\"201\",\"order_id\":
\"\",\"tran_amt\":
\"1\",\"qr_code_info\":
{\"noti_url\":
\"8.30.10:
8088/prodpmpnotify\"},\"tran_cd\":
\"7131\"}"}
异步通知正常应答报文样例：
{"version":
"1.0.0","encoding":
"UTF-8","sign_method":
"01","msg_body":
"{\"ins_id_cd\":
\"\",\"sys_order_id\":
\"2089\",\"tran_cd\":
\"6132\",\"resp_cd\":
\"00\",\"resp_msg\":
\"成功\"}"}
加密方式
11.3.1.3 交易PIN
对于持卡人密码汇宜产品平台使用RSA公钥证书对ANSIX9.8带主帐号格式的PIN加密并做Base64编码后传输，以保障密码的安全性。
依据商户可选配置，对于CVN2、有效期、卡号使用RSA公钥证书分别做加密并Base64处理。
11.3.1.4 敏感信息
对于敏感信息银行卡验证信息及身份信息部分内容，采用Base64编码后传输，以做数据屏蔽。
11.4 数据元长度的计算
数据元长度的计算说明：
所有长度均按字节计算，中文算两个字节，英文、数字算一个字节。
11.5 URL的编码
URL参数中中文等特殊字符需编码。
11.6 数据元类型定义
Axx字节定长的字母字符
Ax..y长度为x-y字节的变长字母字符
ANxx字节定长的字母和/或数字字符
ANx..y长度为x-y字节的变长字母和/或数字字符
ANSxx字节定长的字母、数字和/或特殊符号字符
ANSx..y长度为x-y字节的变长字母、数字和/或特殊符号字符
ASxx字节定长的字母和/或特殊符号字符
ASx..y长度为x-y字节的变长字母和/或特殊符号字符
Nxx字节定长的整型数值，若表示金额，则以分为单位
Nx..y长度为x-y字节的整型数值，若表示金额，则以分为单位
NSxx字节定长的数字符和/或特殊字符
NSx..y长度为x-y字节的数字字符和/或特殊字符
Sxx字节定长的特殊符号字符
Sx..y长度为x-y字节的变长特殊符号字符
ss秒
DD日
hh时
MM月
mm分
YY年（2字节）
YYYY年（4字节）
11.7 数据元说明
产品平台报文接口数据元
序号
数据元名称
数据元标识
数据元格式
数据元取值说明
1.
版本号
version
NS5
1.0.0
2.
证书ID
cert_id
N1..128
填写RSA证书的SerialNumber
3.
签名
signature
ANS1..1024
填写对报文摘要的签名
4.
签名方法
sign_method
N1..12
01：
表示采用RSA
02：
MD5
5.
编码方式
encoding
ANS1..20
UTF-8
6.
交易类型
tran_cd
N4
取值：
5091：
交易查询
1131：
扫码支付
2131：
扫码撤销
3131：
扫码退货
4131：
扫码冲正（关闭当前订单）
7131:
订单创建
1191：
公众号支付
6131:
异步通知
7.
机构号
Ins_id_cd
N8
上送机构号，汇宜分配
8.
密钥机构号
chn_ins_id_cd
N8
密钥机构号,汇宜分配
9.
产品编码
prod_cd
N4
10.
业务编码
biz_cd
N6
依据实际业务场景填写
11.'
商户号
mcht_cd
AN15
汇宜商户号
12.
商户名称
mcht_nm
ANS1..40
汇宜商户名称
13.
商户订单号
order_id
AN6..40
订单号，不能含“-”或“_”唯一记录
14.
订单描述
order_desc
ANS1..32
描述订单信息，显示在交易描述中
15.
订单发送时间
tran_dt_tm
YYYYMMDDhhmmss
终端发送交易时间
16.
原交易日期
orig_trans_dt
YYYYMMD
原交易日期
17.
订单接收超时时间
order_timeout
N1..10
单位为毫秒，交易发生时，该笔交易在后台系统中有效的最长时间。
当距离交易发送时间超过该时间时，汇宜产品平台不再为该笔交易提供支付服务
18.
系统订单号
sys_order_id
AN14
汇宜产品平台订单号
19.
原交易系统订单号
orig_sys_order_id
AN14
汇宜原交易产品平台订单号
20.
交易金额
tran_amt
N1..12
单位为分
21.
清算日期
sett_dt
YYYYMMDD
清算日期
22.
原交易应答码
orig_resp_cd
AN2
23.
原交易应答信息
orig_resp_msg
ANS1..256
24.
应答码
resp_cd
AN2
具体参见应答码定义章节
25.
应答信息
resp_msg
ANS1..256
填写具体的应答信息
26.
扫码信息域
qr_code_info
VAR1…2048
扫码信息域
注0：
qr_code_info
若报文中的数据元标识的key对应的value为空，不上送该报文域；对于组合域，若该组合域无子域上送，该组合域不上送，若子域key对应的value为空，不上送该子域。
扫码数据元相关子域说明
序号
子域名
标识
子域格式
说明
1.
授权码
auth_code
ANS1...128
用户扫码授权码
2.
扫码渠道
qr_type
ANS1..20
ALIPAYWECHAT等
3.
超时时间
time_out
N3
单位为秒
4.
渠道订单号
channel_id
ANS1…64
扫码渠道订单号
5.
用户子ID
open_id
AN…256
6.
用户ID
buyer_id
买家在支付宝的用户id
7.
现金支付金额
cash_amt
8.
代金券金额
coupon_amt
9.
订单完成时间
pay_time
10.
用户登录帐号名称
buyer_user
11.
支付渠道
pay_bank
微信返回字符串支付宝返回json
12.
订单信息
subject
标题
13.
优惠信息
goods_tag
用户微信上传优惠信息参加活动
14.
异步通知url
noti_url
C
异步通知url
15.
支付链接
qr_code
R
qr_code_info扫码子域
支付url，给用户扫码用
16.
用户ID
user_id
C
用户ID
17.
子用户ID
sub_user_id
C
子用户ID
18.
子用户APP_ID
sub_app_id
C
子用户APP_ID
19.
微信jsapi串
wx_jsapi
R
客户端调用API发起调用
20.
支付宝交易号
trade_id
支付宝交易号
21.
订单扩展域1
order_ext1
22.
订单扩展域2
order_ext2
注11：
交易报文
11.8 无卡支付类
交易上送说明
交易产品码统一为1151，业务编码统一为：
，支付宝，苏宁
扫码支付
11.8.1.1 概述
扫码支付是指持卡人在商户终端进行购物等消费时用支持扫码的APP进行支付。
11.8.1.2 交易流程
交易步骤：
1、商户组织扫码交易报文，发送报文给汇宜产品平台；
2、汇宜产品平台完成商户的交易处理；
3、汇宜产品平台组织结果报文，返回给商户；
11.8.1.3 请求报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
1131
7.
机构号
ins_id_cd
M
上送机构号，汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
订单发送时间
tran_dt_tm
M
交易的交易时间
14.
商户订单号
order_id
M
交易的订单号
15.
请求方保留域
req_reserved
O
16.
交易金额
tran_amt
M
交易单位为分
17.
订单支付超时时间
order_timeout
O
单位为秒
18.
风险信息域
risk_info
O
19.
订单信息
order_desc
C
20.
扫码信息域
qr_code_info
M
扫码信息域
21.
授权码
auth_code
M
扫码信息域子域
11.8.1.4 应答报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
1132
7.
机构号
ins_is_id
M
汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
商户订单号
order_id
M
14.
订单发送时间
tran_dt_tm
M
15.
请求方保留域
req_reserved
R
16.
系统订单号
sys_order_id
R
产品平台系统订单号
17.
保留域
reserved
O
18.
交易金额
tran_amt
M
交易单位为分
19.
响应码
resp_cd
M
20.
应答信息
resp_msg
M
21.
清算日期
sett_dt
M
22.
扫码信息域
qr_code_info
M
23.
渠道订单号
channel_id
M
qr_code_info子域
24.
用户子ID
open_id
M
qr_code_info子域
25.
用户id
buyer_id
C
qr_code_info子域内容
26.
现金支付金额
cash_amt
C
qr_code_info子域内容
27.
代金券金额
coupon_amt
C
qr_code_info子域内容
28.
订单完成时间
pay_time
M
qr_code_info子域内容
29.
用户登录帐号名称
buyer_user
C
qr_code_info子域内容
30.
支付渠道
pay_bank
M
qr_code_info子域内容
31.
订单信息
subject
C
qr_code_info子域内容
扫码撤销
11.8.1.5 概述
扫码支付是指持卡人在商户终端进行购物等消费时用支持扫码的APP进行支付。
11.8.1.6 交易流程
交易步骤：
1、商户组织扫码交易报文，发送报文给汇宜产品平台；
2、汇宜产品平台完成商户的交易处理；
3、汇宜产品平台组织结果报文，返回给商户；
11.8.1.7 请求报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
2131
7.
机构代码
ins_in_cd
M
汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
订单发送时间
tran_dt_tm
M
交易的交易时间
14.
商户订单号
order_id
M
交易的订单号
15.
请求方保留域
req_reserved
O
16.
原交易系统订单号
orig_sys_order_id
M
原始交易的sys_order_id
17.
扫码信息域
qr_code_info
O
扫码信息域
18.
交易金额
tran_amt
M
交易单位为分
19.
订单支付超时时间
order_timeout
O
单位为秒
20.
风险信息域
risk_info
O
21.
终端信息域
term_inf
O
移动支付业务需要上送
22.
订单信息
order_desc
C
11.8.1.8 应答报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
2132
7.
机构代码
ins_id_cd
M
汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
商户订单号
order_id
M
14.
订单发送时间
tran_dt_tm
M
15.
请求方保留域
req_reserved
R
16.
系统订单号
sys_order_id
R
产品平台系统订单号
17.
保留域
reserved
O
18.
交易金额
tran_amt
M
交易单位为分
19.
响应码
resp_cd
M
20.
应答信息
resp_msg
M
21.
清算日期
sett_dt
M
22.
扫码信息域
qr_code_info
O
23.
渠道订单号
channel_id
O
qr_code_info子域
24.
用户子ID
open_id
C
qr_code_info子域
25.
现金支付金额
cash_amt
C
qr_code_info子域
26.
代金券金额
coupon_amt
C
qr_code_info子域
27.
订单完成时间
pay_time
O
qr_code_info子域
28.
用户登录帐号名称
buyer_user
C
qr_code_info子域
29.
支付渠道
pay_bank
O
qr_code_info子域
30.
订单信息
subject
C
qr_code_info子域
31.
用户id
buyer_id
C
qr_code_info子域
买家在支付宝的用户id
扫码退货
11.8.1.9 概述
扫码支付是指持卡人在商户终端进行购物等消费时用支持扫码的APP进行支付。
11.8.1.10 交易流程
交易步骤：
1、商户组织扫码交易报文，发送报文给汇宜产品平台；
2、汇宜产品平台完成商户的交易处理；
3、汇宜产品平台组织结果报文，返回给商户；
11.8.1.11 请求报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
3131
7.
机构代码
ins_id_cd
M
汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
订单发送时间
tran_dt_tm
M
交易的交易时间
14.
商户订单号
order_id
M
交易的订单号
15.
请求方保留域
req_reserved
O
16.
原交易系统订单号
orig_sys_order_id
M
原始交易的sys_order_id
17.
原交易日期
orig_tran_dt
M
原交易日期
18.
扫码信息域
qr_code_info
O
扫码信息域
19.
交易金额
tran_amt
M
交易单位为分
20.
订单支付超时时间
order_timeout
O
单位为秒
21.
风险信息域
risk_info
O
22.
终端信息域
term_inf
O
移动支付业务需要上送
23.
订单信息
order_desc
C
11.8.1.12 应答报文
序号
域名
变量名
出现要求
备注
1.
版本号
version
M
固定填写
2.
编码方式
encoding
M
默认取值：
UTF-8
3.
签名
signature
M
填写对报文摘要的签名
4.
签名方法
sign_method
M
取值：
01（表示采用RSA）
5.
以下为msg_body
6.
交易类型
tran_cd
M
3132
7.
机构代码
ins_id_cd
M
汇宜分配
8.
密钥机构号
chn_ins_id_cd
M
上送机构号，汇宜分配
9.
产品编码
prod_cd
M
10.
业务编码
biz_cd
M
11.
商户号
mcht_cd
M
商户编码
12.
终端号
term_id
C
13.
商户订单号
order_id
M
1
升级会员 