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

alipay.eco.cplife.bill.batch.upload (批量上传待缴物业费账单)

批量上传物业公司管理小区待缴物业费信息

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.bill.batch.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 每次上传物业费账单,都需要提供一个批次号。对于每一个合作伙伴,传递的每一个批次号都必须保证唯一性,同时对于批次号内的账单明细数据必须保证唯一性;
建议格式为:8位当天日期+流水号(3~24位,流水号可以接受数字或英文字符,建议使用数字)。
201607192119100001
community_id String 必须 32 支付宝社区小区统一编号,必须在物业账号名下存在。 AJ5OFJC124403
bill_set CPBillSet [] 必须 - 账单应收条目明细集合,同一小区内条目明细不允许重复;一次接口请求最多支持1000条明细。
  • └ bill_entry_id
  • String
  • 必填
  • 32
  • 物业费账单应收明细条目ID,在同一小区内必须唯一,不同小区不做唯一性要求。
  • 15000120160701
  • └ out_room_id
  • String
  • 必填
  • 64
  • 物业系统端房屋编号,必须事先通过房屋信息上传接口上传到支付宝社区物业平台。
  • 453200086
  • └ room_address
  • String
  • 可选
  • 64
  • 对应的房屋门牌地址。若开发者之前通过上传物业小区内部房屋信息接口中的address参数已上传,可不传。
  • 1号102室
  • └ cost_type
  • String
  • 必填
  • 16
  • 费用类型名称,根据物业系统定义传入,支付宝除参数最大长度外不做限定。
  • 物业管理费
  • └ bill_entry_amount
  • String
  • 必填
  • 11
  • 应收金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]
  • 200.00
  • └ acct_period
  • String
  • 必填
  • 16
  • 明细条目所归属的账期,用于归类和向用户展示,具体参数值由物业系统自行定义,除参数最大长度外支付宝不做限定。
  • 2016年07月
  • └ release_day
  • String
  • 必填
  • 8
  • 出账日期,格式固定为YYYYMMDD。
  • 20160701
  • └ deadline
  • String
  • 必填
  • 8
  • 缴费截止日期,格式固定为YYYYMMDD。不能早于调用接口时的当前实际日期(北京时间)和出账日期。
  • 20160831
  • └ relate_id
  • String
  • 可选
  • 64
  • 缴费明细条目关联ID。若物业系统业务约束上传的多条明细条目必须被一次同时支付,则对应的明细条目需传入同样的relate_id。
  • 1234
  • └ remark_str
  • String
  • 可选
  • 64
  • 缴费支付确认页显示给用户的提示确认信息,除房间名外的第二重校验信息,预防用户错缴。建议传入和缴费户相关的信息例如,可传入脱敏后的物业系统中的业主姓名,或其他相关信息。可选参数,不传则不展示。账单明细合并支付时,若部分账单明细的remark_str不同,则默认取第一条有remark_str值的账单明细进行展示。
  • 王*五

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
batch_id String 必填 64 成功导入所有条目集合中的条目,则回传请求中的批次号 201607192119100001

请求示例

  • 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");
AlipayEcoCplifeBillBatchUploadRequest request = new AlipayEcoCplifeBillBatchUploadRequest();
request.setBizContent("{" +
"\"batch_id\":\"201607192119100001\"," +
"\"community_id\":\"AJ5OFJC124403\"," +
"      \"bill_set\":[{" +
"        \"bill_entry_id\":\"15000120160701\"," +
"\"out_room_id\":\"453200086\"," +
"\"room_address\":\"1号102室\"," +
"\"cost_type\":\"物业管理费\"," +
"\"bill_entry_amount\":\"200.00\"," +
"\"acct_period\":\"2016年07月\"," +
"\"release_day\":\"20160701\"," +
"\"deadline\":\"20160831\"," +
"\"relate_id\":\"1234\"," +
"\"remark_str\":\"王*五\"" +
"        }]" +
"  }");
AlipayEcoCplifeBillBatchUploadResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_bill_batch_upload_response":{
		"msg":"Success",
		"code":"10000",
		"batch_id":"201607192119100001"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 使用同样的批次号和业务参数重试发起调用。
NOT_AUTHORIZED_BY_PARTNER 物业未授权给支付宝社区物业平台下单权限 请联系物业完成向社区物业平台应用授权。
ITEM_UNIQUENESS_VIOLATION 请求数据不满足业务唯一性约束 请检查批次号和应收条目明细集合中的数据是否满足唯一性要求,修改并重试。
EXCEED_MAXIMUM_BILLSET_SIZE 请求的账单应收条目数量超限 减少一次上传的条目数量,少于等于参数描述中的上限,重新发起请求。
COMMUNITY_NOT_EXISTING 请求的小区编号在社区物业平台该物业账单下不存在 请通过批量查询支付宝小区编号接口确认授权物业公司账号名下是否存在该小区编号,修改并重试。
ROOM_NOT_EXISTING 请求的房屋在社区物业平台该物业账号下不存在 请调用房屋查询接口确认该物业下是否已上传对应的房屋编号,修改并重试。
INVALID_DEADLINE 缴费截止日期不合法 请检查应收条目的截止日期格式,或者参数值是否早于出账日期或当前实际日期,修改后重新发起请求。
INCONSISTENT_BATCH_ID 不同的上传请求信息使用了同样的批次号 请检查请求参数,修改后重新发起请求。
MERCHANT_NOT_EXISTING 请求上下文中商户信息不存在 请检查接口调用者权限,联系技术支持处理。
INVALID_RELEASE_DAY 待更新的出账日期格式有误 出账日期格式为YYYYMMDD格式,请修改后重试。
INVALID_BILL_ENTRY_AMOUNT 待更新的明细条目金额有误 修改明细条目金额参数值并重新发起请求。

公共错误码

返回
顶部