查询账单
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.ebpp.bill.get |
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 | 详见应用授权概述 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
order_type | String | 必须 | 10 | 支付宝订单类型。公共事业缴纳JF,信用卡还款HK | JF |
merchant_order_no | String | 必须 | 32 | 输出机构的业务流水号,需要保证唯一性。 | 201203031234567 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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_status | String | 必填 | - | 账单的状态。 INIT:等待付款,SUCCESS:成功,FAILED:失败。 | S |
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 | Price | 必填 | - | 缴费金额。用户支付的总金额。单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 | 23.45 |
service_amount | Price | 必填 | - | 账单的服务费 | 8 |
bill_date | String | 必填 | - | 账单的账期,例如201203表示2012年3月的账单。 | 201203 |
traffic_location | String | 必填 | - | 交通违章地点,sub_order_type=TRAFFIC时有值 | 浙江,杭徽高速 |
traffic_regulations | String | 必填 | - | 违章行为,sub_order_type=TRAFFIC时有值。 | 违章停车 |
pay_time | String | 选填 | - | 付款时间 | 2012-01-01 00:22:11 |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayEbppBillGetRequest request = new AlipayEbppBillGetRequest(); request.setOrderType("JF"); request.setMerchantOrderNo("201203031234567"); AlipayEbppBillGetResponse response = alipayClient.execute(request,accessToken); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "alipay_ebpp_bill_get_response":{ "owner_name":"织绫", "bill_date":"201203", "pay_amount":23.45, "traffic_regulations":"违章停车", "traffic_location":"浙江,杭徽高速", "bill_key":"3388102012376451", "merchant_order_no":"201203031234567", "pay_time":"2012-01-01 00:22:11", "order_status":"S", "service_amount":8, "sub_order_type":"WATER", "charge_inst":"BJCEB", "alipay_order_no":"201203088888888", "charge_inst_name":"北京光大", "order_type":"JF" } }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "alipay_ebpp_bill_get_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
isv.invalid-auth-token | 支付宝授权信息无效 | 参照网页授权获取 |
isv.order-type-cannot-access | 此业务类型不允许访问 | 检查业务类型是否传正确了。 |
isv.invalid-arguments | 参数无效 | 检查输入参数的正确性 |
isp.unknown-error | 未知异常 | 重试 |
isv.bill-is-not-exisit | 账单不存在 | 更换查询条件 |
isv.order-type-error | 业务类型错误 | 检查业务类型 |
isv.invalid-access-other-bill | 非法访问他人的订单 | 检查查询参数 |