测试地址:http://116.228.64.55:28082/yst-service-api/tm/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tm/handle
接口代码(transCode):4001
功能说明:
(1)该接口用于维护终端信息,在付款码支付前需完成(收银宝付款码支付(CODEPAY_VSP/CODEPAY_VSP_ORG)维护。
(2)通过termno上送终端的自定义管理编号,保证商户号下唯一,且必须为8位数字。
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
orgId |
String |
15 |
否 |
收银宝集团商户号 |
集团模式:集团商户收银宝商户号 单商户模式:不填 |
cusId |
String |
15 |
是 |
收银宝商户号 |
单商户模式:商户收银宝商户号 集团模式:收银宝子商户号 |
termNo |
String |
8 |
是 |
终端号 |
8位数字 |
operation |
String |
2 |
是 |
操作类型 |
取值范围: 00:新增; 01:修改; 02:注销; 03:查询; 注:当“termStatusMsg -终端报备状态”为“受理成功”时不能“修改”和“注销” |
deviceType |
String |
2 |
否 |
设备类型 |
10:条码支付受理终端(此类型终端为满足银联认证的厂商终端,且填写终端序列号); 11:条码支付辅助受理终端; 仅当“操作类型”为“00:新增”、“01:修改”、“02:注销”,必填 |
termSn |
String |
50 |
否 |
终端序列号 |
仅当“操作类型”为“00-新增”、“01-修改”、“02-注销”且“设备类型”为“10”时,必填; |
termState |
String |
2 |
否 |
终端状态 |
00:启用; 01:注销; 仅当“操作类型”为“00-新增”、“01-修改”,必填 |
termaddress |
String |
100 |
否 |
终端地址 |
仅当“操作类型”为“00-新增”、“01-修改”,必填; 省-市-区-详细地址,详细地址长度控制在 30 个汉字以内注:取值范围可参考《省市区结构说明》 |
queryType |
String |
3 |
否 |
查询类型 |
AT/UAT 1.空或者AT时仅返回AT报备状态 2.UAT的时候返回AT加银联报备状态 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
retCode |
String |
8 |
是 |
收银宝终端“新建、修改、注销、查询”结果 |
成功:OK 失败:error |
retMsg |
String |
100 |
否 |
终端报备状态 |
受理成功 报备成功 |
orgId |
String |
15 |
否 |
收银宝集团商户号 |
仅操作类型为“03:查询”且为集团商户时,返回 |
cusId |
String |
15 |
否 |
收银宝商户号 |
单商户模式:商户收银宝商户号 集团模式:收银宝子商户号 仅操作类型为“03:查询”时,返回; |
appid |
String |
8 |
否 |
收银宝应用号 |
仅操作类型为“03:查询”时,返回 |
termNo |
String |
8 |
否 |
终端号 |
仅操作类型为“03:查询”时,返回 |
deviceType |
String |
2 |
否 |
设备类型 |
仅操作类型为“03:查询”时,返回 |
termSn |
String |
50 |
否 |
终端序列号 |
仅操作类型为“03:查询”时,返回 |
termState |
String |
2 |
否 |
终端状态 |
仅操作类型为“03:查询”时,返回 |
termAddress |
String |
100 |
否 |
终端地址 |
仅操作类型为“03:查询”时,返回 |
errorCode |
String |
5 |
否 |
错误代码 |
仅当retCode=error时有值 透传渠道错误代码 |
errorMsg |
String |
100 |
否 |
错误信息 |
仅当retCode=error时有值 透传渠道错误信息 |
wxState |
String |
4 |
否 |
微信报备状态 |
0000:成功 0001:报备处理中 3999:失败 注:“operation-操作类型”为“03:查询”时返回; |
wxMsg |
String |
100 |
否 |
微信报备信息 |
|
alState |
String |
4 |
否 |
支付宝报备状态 |
0000:报备成功 0001:报备处理中 3999:报备失败 注:“operation-操作类型”为“03:查询”时返回; |
alMsg |
String |
100 |
否 |
支付宝报备信息 |
|
unState |
String |
4 |
否 |
银联报备状态 |
0000:报备成功 0001:报备处理中 3999:报备失败 注:“operation-操作类型”为“03:查询”时返回; |
unMsg |
String |
100 |
否 |
银联报备信息 |
|
respCode |
String |
5 |
是 |
响应码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
响应信息 |
终端信息详细字段
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
termNo |
String |
是 |
终端号 |
8位数字 一个收银宝商户号对应一个终端号; 商户需先调用【终端信息管理接口】报备; |
devicetype |
String |
是 |
设备类型 |
10:条码支付受理终端(此类型终端为满足银联认证的厂商终端,且需填写终端序列号); 11:条码支付辅助受理终端; |
termsn |
String |
否 |
终端序列号 |
“设备类型-devicetype”为10时,必填; |
longitude |
Sting |
否 |
经度 |
经度信息格式:1位正负号+3位整数 +1位小数点 +5位小数, +表示东经, -表示西经,例如 +121.48352 银联扫码必送 |
latitude |
Sting |
否 |
纬度 |
纬度信息格式:1位正负号+2位整数+1位小数点 +6 位小数,+表示北纬, -表示南纬,例如+31.221345或-03.561345 银联扫码必送 |
deviceip |
String |
否 |
商户端终端设备 IP 地址 |
注:终端IP-deviceip/经纬度-location——二选一必填 |
encryptrandnum |
String |
否 |
加密随机因子 |
取值:付款码后6位 |
secrettext |
String |
否 |
64bit 的密文数据 |
对终端硬件序列号和加密随机因子加密后的结果。本子域取值为:64bit 密文数据进行base64 编码后的结果。 |
appversion |
String |
否 |
终端应用程序的版本号 |
应用程序变更应保证版本号不重复。最大长度8位,当长度不足时,右补空格。 |
“reqsUrl-前台通知地址”页面跳转返回的数据
字段名 |
字段类型 |
必填 |
字段中文 |
说明 |
result |
String |
是 |
订单状态 |
订单成功时会发订单结果通知商户。 |
reqTraceNum |
String |
是 |
商户订单号 |
|
respTraceNum |
String |
是 |
通联订单号 |
|
orderAmount |
Long |
是 |
订单金额 |
单位:分 |
payAmount |
Long |
是 |
支付金额 |
支付金额=订单金额-营销金额 |
promotionAmount |
Long |
否 |
营销金额 |
|
finishTime |
String |
否 |
订单支付完成时间 |
云商通订单支付完成时间 |
extendParams |
String |
否 |
接口将原样返回,不可包含“|”特殊字符 |