文档中心 > API类目 > 社区物业API

alipay.eco.cplife.residentinfo.upload (物业小区业主信息上传)

物业公司调用该接口将小区的业主信息同步至支付宝平台绑定支付宝账户。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.residentinfo.upload
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
batch_id String 必须 64 请求流水号,由商户自定义,在商户系统内唯一标示一次业务请求。 2014072300007148
community_id String 必须 32 业主所在物业小区ID(支付宝平台唯一小区ID标示) AJ5OFJC443301
resident_info CplifeResidentInfo [] 必须 - 请求上传的住户信息列表,单次至多上传200条住户信息.
  • └ out_resident_id
  • String
  • 必填
  • 64
  • 物业系统中小区住户的唯一ID标识.
  • 201648996539765
  • └ idcard_no
  • String
  • 必填
  • 32
  • 业主身份证号的MD5结果
  • 900150983cd24fb0d6963f7d28e17f72
  • └ name
  • String
  • 必填
  • 32
  • 用户的真实姓名
  • 张三
  • └ out_entity_id
  • String
  • 特殊可选
  • 64
  • 业主关联的房产在物业系统中的唯一标识。(该属性和entity_id两个至少需要填写一项,如果两项都填写则以entity_id为准.)
  • 201648996539765
  • └ entity_id
  • String
  • 特殊可选
  • 64
  • 业主关联的房产在支付宝平台中的唯一标识。(该属性和property_entity_id两个至少需要填写一项,如果两项都填写则以entity_id为准.)
  • AEYPHY16E3711800007010301
  • └ type
  • String
  • 必填
  • 2
  • 用户对房产的关系类型。业主:1;家人:2;租客:3
  • 1

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoCplifeResidentinfoUploadRequest request = new AlipayEcoCplifeResidentinfoUploadRequest();
request.setBizContent("{" +
"\"batch_id\":\"2014072300007148\"," +
"\"community_id\":\"AJ5OFJC443301\"," +
"\"resident_info\":[{" +
"\"out_resident_id\":\"201648996539765\"," +
"\"idcard_no\":\"900150983cd24fb0d6963f7d28e17f72\"," +
"\"name\":\"张三\"," +
"\"out_entity_id\":\"201648996539765\"," +
"\"entity_id\":\"AEYPHY16E3711800007010301\"," +
"\"type\":\"1\"" +
"}]" +
"}");
AlipayEcoCplifeResidentinfoUploadResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_eco_cplife_residentinfo_upload_response":{
		"msg":"Success",
		"code":"10000"
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_eco_cplife_residentinfo_upload_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 根据接口文档校验并修改参数后重新请求
SYSTEM_ERROR 系统繁忙 请稍后重试.
INCONSISTENT_BATCH_ID 不同的上传请求信息使用了同样的批次号 请检查请求参数,修改后重新发起请求。
COMMUNITY_NOT_EXISTING 请求的小区在社区物业平台该商户名下不存在 请至社区物业平台小区管理列表中检查该商户下是否有对应ID的小区。
ROOM_NOT_EXISTING 请求的房屋在社区物业平台该商户名下不存在 请至社区物业平台小区结构管理列表中查询该商户下是否有对应的房屋。
EXCEED_MAXIMUM_BATCH_SIZE 上传用户数超出系统限制 一次仅允许上传不超过200条住户信息,请修改参数后重新提交.

公共错误码

返回
顶部