文档中心 > API类目 > 生活缴费API

alipay.ebpp.bill.add (创建账单)

创建账单

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.bill.add
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
auth_token String 40 针对用户授权接口,获取用户相关数据时,用于标识用户授权关系。详见用户信息授权
app_auth_token String 40 详见应用授权概述

请求参数

参数 类型 是否必填 最大长度 描述 示例值
merchant_order_no String 必须 32 输出机构的业务流水号,需要保证唯一性 201203031234567
order_type String 必须 10 支付宝订单类型。公共事业缴纳JF,信用卡还款HK JF
sub_order_type String 必须 10 子业务类型是业务类型的下一级概念,例如:WATER表示JF下面的水费,ELECTRIC表示JF下面的电费,GAS表示JF下面的燃气费。 WATER
charge_inst String 必须 80 支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。 BJCEB
bill_key String 必须 50 账单单据号,例如水费单号,手机号,电费号,信用卡卡号。没有唯一性要求。 3388102012376451
owner_name String 可选 50 拥有该账单的用户姓名 织绫
pay_amount Price 必须 - 缴费金额。用户支付的总金额。单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 23.45
service_amount Price 可选 - 账单的服务费。 8
bill_date String 可选 - 账单的账期,例如201203表示2012年3月的账单。 201203
mobile String 必须 - 用户的手机号 15987838584
traffic_location String 可选 - 交通违章地点,sub_order_type=TRAFFIC时填写。 浙江,杭徽高速
traffic_regulations String 可选 - 违章行为,sub_order_type=TRAFFIC时填写。 窜红灯
bank_bill_no String 可选 - 外部订单号 20130916
extend_field String 可选 - 扩展属性 {"key1":"value1","key2":"value2","key3":"value3","key4":"value4"}

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
merchant_order_no String 必填 - 输出机构的业务流水号,需要保证唯一性。 201203031234567
alipay_order_no String 必填 - 支付宝的业务订单号,具有唯一性。 201203088888888
order_type String 必填 - 支付宝订单类型。公共事业缴纳JF,信用卡还款HK JF
sub_order_type String 必填 - 子业务类型是业务类型的下一级概念,例如:WATER表示JF下面的水费,ELECTRIC表示JF下面的电费,GAS表示JF下面的燃气费。 WATER
charge_inst String 必填 - 支付宝给每个出账机构指定了一个对应的英文短名称来唯一表示该收费单位。 BJCEB
charge_inst_name String 必填 - 出账机构中文名称。 北京光大
bill_key String 必填 - 账单单据号,例如水费单号,手机号,电费号,信用卡卡号。没有唯一性要求。 3388102012376451
owner_name String 必填 - 拥有该账单的用户姓名 织绫
pay_amount String 必填 - 缴费金额。用户支付的总金额。单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 23.45
service_amount String 选填 - 账单的服务费 8
bill_date String 必填 - 账单的账期,例如201203表示2012年3月的账单。 201203
bank_bill_no String 选填 - 外部订单号,由于对账时回传给外部商户 20130705
extend_field String 选填 - 扩展属性,该属性值现在用于确保只有一个人可以支付成功
用法:多个人对同一笔外部欠费单创建多个账单时,确保该值不变
20140504

请求示例

  • 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");
AlipayEbppBillAddRequest request = new AlipayEbppBillAddRequest();
request.setMerchantOrderNo("201203031234567");
request.setOrderType("JF");
request.setSubOrderType("WATER");
request.setChargeInst("BJCEB");
request.setBillKey("3388102012376451");
request.setOwnerName("织绫");
request.setPayAmount(23.45);
request.setServiceAmount(8);
request.setBillDate("201203");
request.setMobile("15987838584");
request.setTrafficLocation("浙江,杭徽高速");
request.setTrafficRegulations("窜红灯");
request.setBankBillNo("20130916");
request.setExtendField("{"key1":"value1","key2":"value2","key3":"value3","key4":"value4"}");
AlipayEbppBillAddResponse response = alipayClient.execute(request,accessToken);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_ebpp_bill_add_response":{
		"owner_name":"织绫",
		"bank_bill_no":"20130705",
		"bill_date":"201203",
		"pay_amount":"23.45",
		"bill_key":"3388102012376451",
		"merchant_order_no":"201203031234567",
		"service_amount":"8",
		"sub_order_type":"WATER",
		"charge_inst":"BJCEB",
		"alipay_order_no":"201203088888888",
		"extend_field":"20140504",
		"charge_inst_name":"北京光大",
		"order_type":"JF"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
isv.invalid-arguments 参数无效 检查参数正确性
isv.invalid-auth-token 支付宝授权信息无效 参照网页授权获取
isv.order-type-cannot-access 此业务类型不允许访问 检查业务类型是否传正确了。
isp.unknow-error 未知异常 重试获取最终结果
isv.pay-bill-is-complete 此账单已付款 创建失败走失败流程
isv.pay-bill-is-closed 此账单已关闭或者已失败 创建失败
isv.create-bill-is-wait-pay 此账单已创建,正等待支付 调支付接口
isv.query-bill-error 查询欠费信息失败 失败
isv.charge-inst-cannot-use 收费单位不可用 检查出账机构短名称是否正确,同时检查业务类型和子业务类型和出账机构是否匹配。如果都正常的话,那该收费单位确实不可用。

公共错误码

返回
顶部