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

alipay.ebpp.jfexport.instbill.query (查询缴费业务输出的机构账单)

查询到缴费业务输出的出账机和对应出账机构的输入域配置后,再查询特定出账机构的机构账单

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.jfexport.instbill.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
biz_type String 必须 10 业务类型英文名称 ,固定传JF,表示缴费 JF
sub_biz_type String 必须 10 子业务类型英文名称,ELECTRIC-电费,WATER-水费,GAS-燃气费 GAS
bill_key String 必须 50 户号 01284845
owner_name String 可选 100 账单拥有者姓名 张三
bill_date String 可选 10 账期 201703
charge_inst String 必须 80 出账机构英文简称 CZSTRQ3083
extend_field String 可选 2000 拓展字段,json串(key-value对) {"name":"张三"}

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
cache_key String 必填 100 "utility_" + uniqId,缓存的账单的key,每次查询均保证唯一性,但是不保证幂等性,在创建时需要透传回支付宝这边。 utility_4cdbc040657a4847b2667e31d9e2c3d9
biz_type String 必填 10 业务类型英文名称 JF
sub_biz_type String 必填 10 子业务类型英文简称 WATER
bill_key String 必填 50 户号 23314134
owner_name String 选填 100 账单拥有者姓名 张三
charge_inst String 必填 80 出账机构英文简称 SHWATER
charge_mode String 必填 10 缴费模式:2-账单模式;4-缴清欠费模式;5-欠费自由缴模式。 2
extend_field String 选填 2000 拓展字段,json串(key-value对) {"billDate":"20170321"}
inst_bills JfExportInstBillModel [] 必填 - 机构账单列表,如果有多条,只允许选择其中的一条进行支付。
  • └ uniq_id
  • String
  • 必填
  • 100
  • 唯一标识,每次查询均保证唯一性,但是不保证幂等性
  • 4cdbc040657a4847b2667e31d9e2c3d9
  • └ amount
  • Price
  • 必填
  • 10
  • 账单金额,单位为:RMB元。
  • 100.00
  • └ bill_fines
  • Price
  • 选填
  • 10
  • 滞纳金,单位为:RMB元。
  • 10.00
  • └ balance
  • Price
  • 选填
  • 10
  • 余额,单位为:RMB元。
  • 66.00
  • └ bill_key
  • String
  • 必填
  • 50
  • 户号
  • 23314134
  • └ owner_name
  • String
  • 选填
  • 100
  • 账单拥有者姓名
  • 张三
  • └ inst_bill_no
  • String
  • 选填
  • 32
  • 机构流水号
  • 2017050610000001
  • └ bill_date
  • String
  • 选填
  • 10
  • 账期
  • 20170506
  • └ extend_field
  • String
  • 选填
  • 2000
  • 拓展字段,json串(key-value对)
  • {"billDate":"20170321"}

请求示例

  • 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");
AlipayEbppJfexportInstbillQueryRequest request = new AlipayEbppJfexportInstbillQueryRequest();
request.setBizContent("{" +
"\"biz_type\":\"JF\"," +
"\"sub_biz_type\":\"GAS\"," +
"\"bill_key\":\"01284845\"," +
"\"owner_name\":\"张三\"," +
"\"bill_date\":\"201703\"," +
"\"charge_inst\":\"CZSTRQ3083\"," +
"\"extend_field\":\"{\\\"name\\\":\\\"张三\\\"}\"" +
"  }");
AlipayEbppJfexportInstbillQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_ebpp_jfexport_instbill_query_response":{
		"msg":"Success",
		"inst_bills":[
			{
				"amount":100.00,
				"uniq_id":"4cdbc040657a4847b2667e31d9e2c3d9",
				"owner_name":"张三",
				"balance":66.00,
				"inst_bill_no":"2017050610000001",
				"bill_date":"20170506",
				"bill_fines":10.00,
				"extend_field":"{\"billDate\":\"20170321\"}",
				"bill_key":"23314134"
			}
		],
		"sub_biz_type":"WATER",
		"code":"10000",
		"owner_name":"张三",
		"charge_inst":"SHWATER",
		"cache_key":"utility_4cdbc040657a4847b2667e31d9e2c3d9",
		"biz_type":"JF",
		"extend_field":"{\"billDate\":\"20170321\"}",
		"charge_mode":"2",
		"bill_key":"23314134"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后再试
CHARGEINST_NOT_AUTHORIZED 出账机构未授权访问 出账机构未授权访问,请修改出账机构参数
INPUTFIELD_VALIDATE_ERROR 输入域校验异常 输入域校验异常,请检查参数或者更新输入域配置
INVALID_PARAMETER 参数有误,入参不符合要求 请确保入参格式、内容符合接口文档描述中的要求
INVALID_PARAMETER 参数有误,biz_type参数有误 请确保入参格式、内容符合接口文档描述中的要求
INVALID_PARAMETER 参数有误,sub_biz_type参数有误 请确保入参格式、内容符合接口文档描述中的要求
INVALID_PARAMETER 参数有误,charge_inst参数有误 请确保入参格式、内容符合接口文档描述中的要求
INVALID_PARAMETER 参数有误,bill_key参数有误 请确保入参格式、内容符合接口文档描述中的要求
BILL_ALREADY_EXPIRED 账单已经过期 账单已经过期,请稍后再试
BIZ_ERROR 业务异常*** 业务异常,请关注错误详细描述或者稍后重试
INST_CANNOT_USE 机构不可用*** 机构不可用,请关注错误详细描述或者稍后重试
BILL_BINDING_DEDUCT 银行代扣期间禁止缴费 银行代扣期间禁止缴费
CHARGE_BILL_PAY_NO_AMOUNT 没有欠费记录,或者缴费号码有误 没有欠费记录,或者缴费号码有误
BILL_KEY_NOT_LEGAL 户号有误*** 户号有误,请关注错误详细描述或者稍后重试
BILL_NOT_OUT 机构暂未出账*** 机构暂未出账,请关注错误详细描述或者稍后重试

公共错误码

返回
顶部