楼房信息推送API

1、修订记录

修订记录 日期 说明
1.0 2026.10.28 初版

2、业务说明

(1)接口说明

物业公司上送小区房屋信息。每上线一个新项目(小区)时,需要调这个接口,推送小区楼房信息给微信生活缴费,以便用户缴费时选择为哪个楼房缴费

请求主体类型:application/json

请求方式:POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay-test.com/openapi/lifepay/mp/server/push/building/info
正式环境 https://ysgate.ysepay.com/openapi/lifepay/mp/server/push/building/info

4、请求参数说明

4.1、公共请求参数

参数 类型(长度) 必填 参数说明
timeStamp String Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称,固定值:lifepay.mp.server.push.building.info
charset String(10) Y 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8
sign String Y 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名
check String Y 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo
bizContent String Y 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent
reqId String Y 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602
certId String Y 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号
version String Y 调用的接口版本,固定为:1.0

4.2、业务请求参数

(bizContent加密前的json数据明文字符串)

参数 类型(长度) 必填 参数说明
merchantNo String(32) Y 商户号(微信生活缴费商户号,对应物业公司)
opType String Y 变更类型:add/delete/edit/search
companyId String Y 项目id(微信生活缴费项目id)
dataList Array Y 楼房信息

4.2.1 dataList具体参数

参数 类型(长度) 必填 参数说明
billKey String Y 户号(物业公司为每套楼房定义的唯一编号)
firstAddrName String Y 一级房屋地址名,例如:远景大厦一期
firstAddrNo String N 一级房屋编号,例如:P101
firstAddrOrderNum int N 一级房屋次序,例如:1
secondAddrName String N 二级房屋地址名,例如:3号楼
secondAddrNo String N 二级房屋编号,例如:3号楼
secondAddrOrderNum int N 二级房屋次序,例如:3
thirdAddrName String N 三级房屋地址名,例如:10单元
thirdAddrNo String N 三级房屋编号,例如:U10
thirdAddrOrderNum int N 三级房屋次序,例如:10
fourthAddrName String N 四级房屋地址名,例如:1811室
fourthAddrNo String N 四级房屋编号,例如:R1811
fourthAddrOrderNum int N 四级房屋次序,例如:11

5、响应参数说明

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1、公共响应参数

参数 类型(长度) 必填 参数说明
code String(5) Y 网关响应码,示例值:00000 ,详见网关公共响应码
msg String(50) Y 网关响应码描述
subCode String Y 业务响应码,参见具体的API接口文档
subMsg String Y 业务响应描述
timeStamp String Y 响应时间,格式"yyyy-MM-dd HH:mm:ss"
norce String(128) Y 随机参数
sign String Y 响应参数的签名串,详见demo,
注意:请用银盛公钥进行验签
businessData String Y 业务响应参数集合,
注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo

5.2、业务响应参数

响应业务参数businessData(json数据)

参数 类型(长度) 必填 参数说明
businessData Object N 响应数据
reqMsgId String N 请求流水号

5.2.1 businessData具体参数

参数 类型(长度) 必填 参数说明
retCode String Y 业务返回码,0代表业务调用成功,1代表调用失败,2代表房屋信息无需同步

6、业务响应码 网关公共响应码

响应码 响应码描述 解决方案
0 0是调用成功,其它都是调用失败 当subCode返回等于0才是系统调用成功,系统调用成功不代表业务调用成功,业务调用成功需要判断businessData.retCode。

results matching ""

    No results matching ""