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

alipay.eco.cplife.basicservice.initialize (初始化小区物业基础服务)

开发者通过该接口帮助物业公司或其他小区管理主体在支付宝已创建的小区中初始化物业缴费等基础服务信息。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.basicservice.initialize
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
community_id String 必须 32 支付宝社区小区统一编号,必须在物业账号名下存在。 AJ5OFJC124403
service_type String 必须 32 基础服务类型,目前支持的类型值为:
PROPERTY_PAY_BILL_MODE - 物业缴费账单上传模式
PROPERTY_PAY_BILL_MODE
external_invoke_address String 必须 512 由开发者系统提供的,支付宝根据基础服务类型在特定业务环节调用的外部系统服务地址,开发者需要确保外部地址的准确性。在线上环境需要使用HTTPS协议,会检查ssl证书,要求证书为正规的证书机构签发,不支持自签名证书。
对于PROPERTY_PAY_BILL_MODE服务类型,该地址表示用户缴费支付完成后开发者系统接受支付结果通知的回调地址。
https://example.com/gateway.do
account_type String 可选 32 若服务类型为物业缴费账单模式,每个小区默认的收款账号为授权物业的支付宝账号,默认不用传该参数。用户完成缴费后实时入账至该支付宝账号,后续由物业财务系统根据缴费异步通知和支付宝对账文件进行资金清分。

但为了满足部分物业公司的财务清结算需求,允许在授权物业账号下已设置支付宝收款子账号限制集的前提下,由开发者为指定小区服务传入一个物业公司的支付宝收款子帐号,支持通过以下任一种形式传递该账号:

ALIPAY_LOGON_ID - 支付宝登陆账号。

ALIPAY_PARTNER_ID - 支付宝登陆账号对应的用户ID,2088开头的16位纯数字用户号。

注意:若传递的收款子账号事先未在支付宝配置,开发者在上线前的支付验证环节会提示不支持收款到该账户,请联系物业公司完成配置事宜。
ALIPAY_PARTNER_ID
account String 可选 64 若服务类型为物业缴费账单模式,每个小区默认的收款帐号为授权物业的支付宝账号,默认不用传该参数。
但为满足部分物业公司财务要求,允许开发者为每个小区服务传入一个指定的物业收款帐号。根据不同账号类型(account_type),开发者需要向物业或支付宝商务支持接口人获取具体的收款帐号。
2088501624560333
service_expires Date 可选 20 若本服务有预期的过期时间(如在物业服务合同中约定),开发者按标准时间格式:yyyy-MM-dd HH:mm:ss传入。 2017-12-31 23:59:59

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
status String 选填 64 若服务成功初始化,则返回当前状态。
服务初始化后默认为下线状态,需要完成开发和验证,并提交服务上线申请。由支付宝小二审核通过后完成服务和小区上线。
OFFLINE
next_action String 选填 64 服务初始化成功后,若从当前状态到下一状态需要完成下一步条件代码,则返回该字段,否则不返回。
操作主体有:
INVOKER - 接口调用方
MERCHANT - 物业公司
AUDITOR - 平台审核方
条件代码包括但不限于:
WAIT_SERVICE_PROVISION - 等待基础服务初始化
WAIT_PROD_VERIFICATION - 等待在生产环境通过自测
WAIT_ONLINE_APPLICATION - 等待提起上线申请(目前支持开发者调用alipay.eco.cplife.basicservice.modify接口发起上线申请)
WAIT_CONFIRMATION - 等待相关方确认
WAIT_AUDITING - 等待审核
WAIT_PROD_VERIFICATION|MERCHANT
bill_pay_auth_url String 选填 512 若初始化的服务类型为物业缴费账单上传模式,并且对应的物业账号事前未完成对支付宝平台代创建缴费交易的授权,接口除了返回对应错误码,会通过本参数返回授权URL。请开发者发给物业人员用对应的物业支付宝账号登录完成第三方授权。 https://openauth.alipay.com/oauth2/appToAppAuth.htm?app_id=20160621015123456&redirect_uri=https%3a%2f%2fhelloworld.com

请求示例

  • 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");
AlipayEcoCplifeBasicserviceInitializeRequest request = new AlipayEcoCplifeBasicserviceInitializeRequest();
request.setBizContent("{" +
"\"community_id\":\"AJ5OFJC124403\"," +
"\"service_type\":\"PROPERTY_PAY_BILL_MODE\"," +
"\"external_invoke_address\":\"https://example.com/gateway.do\"," +
"\"account_type\":\"ALIPAY_PARTNER_ID\"," +
"\"account\":\"2088501624560333\"," +
"\"service_expires\":\"2017-12-31 23:59:59\"" +
"  }");
AlipayEcoCplifeBasicserviceInitializeResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_eco_cplife_basicservice_initialize_response":{
		"msg":"Success",
		"code":"10000",
		"next_action":"WAIT_PROD_VERIFICATION|MERCHANT",
		"bill_pay_auth_url":"https://openauth.alipay.com/oauth2/appToAppAuth.htm?app_id=20160621015123456&redirect_uri=https%3a%2f%2fhelloworld.com",
		"status":"OFFLINE"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 业务可能还在处理中,请稍后调用查询单个物业小区信息接口确认服务初始化结果,若接口未返回对应服务信息,请重试。
COMMUNITY_NOT_EXISTING 请求的小区编号在当前物业账号名下不存在。 请通过小区查询接口确认授权物业公司账号名下是否存在该小区编号。请修改小区编号并重试。
SERVICE_UNIQUENESS_VIOLATION 指定小区已存在同类服务,且该服务类型不允许同时注册多个同类服务。 指定小区已存在同类服务,请确认。可修改小区编号或服务类型并重试。
INVALID_SERVICE_TYPE 服务类型非法。 传入的服务类型不支持,请按照接口文档列举的值修改并重试。
INVALID_EXTERNAL_ADDRESS 外部系统服务地址未通过校验 提供的外部系统服务地址格式未通过校验(例如线上环境未传递https协议开头的地址),请修改并重试。
INVALID_ACCOUNT_TYPE 收款帐号类型非法。 传入的收款帐号类型不支持,请按照接口文档列举的值修改并重试。
INVALID_ACCOUNT 收款帐号非法。 传入的收款帐号不存在或格式非法,请开发者和物业确认收款帐号有效性,修改并重试。
INVALID_SERVICE_EXPIRES 服务过期时间非法。 请按照yyyy-MM-dd HH:mm:ss的标准时间格式传入合理的服务过期时间,修改并重试。
WAIT_MERCHANT_AUTH_TO_PLATFORM 商户账号未授权给支付宝平台下单权限 请开发者查看在线物业缴费产品接入指南,联系并指导物业相关人员完成给支付宝平台授权工作。

公共错误码

返回
顶部