提供给朗新查询代扣协议状态的接口,用于进行双边对账,解决单边协议问题
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.ebpp.pdeduct.sign.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 | 是 | 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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
user_id | String | 必须 | 16 | 用户ID | 2088302186230962 |
agreement_id | String | 特殊可选 | 32 | 支付宝代扣协议Id。若协议id不传递,则需要保证业务类型、子业务类型、出账机构、户号必传 | 1234557890 |
biz_type | String | 特殊可选 | 32 | 业务类型。
JF:缴水、电、燃气、固话宽带、有线电视、交通罚款费用 WUYE:缴物业费 HK:信用卡还款 TX:手机充值 |
JF |
sub_biz_type | String | 特殊可选 | 32 | 业务子类型。
WATER:缴水费 ELECTRIC:缴电费 GAS:缴燃气费 COMMUN:缴固话宽带 CATV:缴有线电视费 TRAFFIC:缴交通罚款 WUYE:缴物业费 HK:信用卡还款 CZ:手机充值 |
ELECTRIC |
charge_inst | String | 特殊可选 | 50 | 支付宝缴费系统中的出账机构ID | CQCENTERELECTRIC |
bill_key | String | 特殊可选 | 32 | 户号,机构针对于每户的水、电都会有唯一的标识户号 | 02659981 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
agreement_id | String | 必填 | 32 | 协议ID | 20160331000700130000930600556911 |
sign_date | String | 必填 | 50 | 签约时间 | 2016-02-03 18:00:00 |
charge_inst | String | 必填 | 100 | 出账机构 | HZYHWATER |
user_id | String | 必填 | 16 | 用户ID | 2088022621144305 |
bill_key | String | 选填 | 50 | 户号 | 03983123 |
out_agreement_id | String | 必填 | 50 | 朗新协议ID | 738F4D9B6F825FDE9D07773E08BD0A2E |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayEbppPdeductSignQueryRequest request = new AlipayEbppPdeductSignQueryRequest(); request.setBizContent("{" + "\"user_id\":\"2088302186230962\"," + "\"agreement_id\":\"1234557890\"," + "\"biz_type\":\"JF\"," + "\"sub_biz_type\":\"ELECTRIC\"," + "\"charge_inst\":\"CQCENTERELECTRIC\"," + "\"bill_key\":\"02659981\"" + " }"); AlipayEbppPdeductSignQueryResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "alipay_ebpp_pdeduct_sign_query_response":{ "msg":"Success", "code":"10000", "agreement_id":"20160331000700130000930600556911", "charge_inst":"HZYHWATER", "user_id":"2088022621144305", "sign_date":"2016-02-03 18:00:00", "out_agreement_id":"738F4D9B6F825FDE9D07773E08BD0A2E", "bill_key":"03983123" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
{ "alipay_ebpp_pdeduct_sign_query_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 系统繁忙 | 系统异常,一般是数据库原因,或是无法预知的系统错误 |
QUERY_DEDUCT_SIGN_INFO_ERROR | 查询协议异常 | 一般是调用底层系统查询协议的时候超时 |
DEDUCT_SIGN_INFO_NOT_EXIST | 协议不存在 | 说明两边的协议不一致,需要机构核实是否单边账 |
PARAMETER_ILLEGAL | 传入的参数非法 | 检查agreementId为空的情况下,业务类型、子业务类型、出账机构、户号参数是否合法 |