缴费直连代扣签约
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.ebpp.pdeduct.sign.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 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
pay_password_token | String | 必须 | 32 | 用户签约时,跳转到支付宝独立密码校验页面,校验成功后会将token和对应的用户ID缓存下来,然后跳回到机构页面生成token带回给机构,机构签约时必须传入token | 11505a6f41688644a4b85f9bf80ef071 |
user_id | String | 必须 | 16 | 用户ID | 2088111133334134 |
biz_type | String | 必须 | 32 | 业务类型。
JF:缴水、电、燃气、固话宽带、有线电视、交通罚款费用 WUYE:缴物业费 HK:信用卡还款 TX:手机充值 |
JF |
sub_biz_type | String | 必须 | 32 | 业务子类型。
WATER:缴水费 ELECTRIC:缴电费 GAS:缴燃气费 COMMUN:缴固话宽带 CATV:缴有线电视费 TRAFFIC:缴交通罚款 WUYE:缴物业费 HK:信用卡还款 CZ:手机充值 |
ELECTRIC |
bill_key | String | 必须 | 32 | 户号,机构针对于每户的水、电都会有唯一的标识户号 | 02659981 |
owner_name | String | 可选 | 32 | 户名,户主真实姓名 | 王海龙 |
pid | String | 必须 | 16 | 商户ID | 2088102118849556 |
charge_inst | String | 必须 | 50 | 支付宝缴费系统中的出账机构ID | CQCENTERELECTRIC |
out_agreement_id | String | 必须 | 32 | 外部产生的协议ID | 123456 |
agent_channel | String | 必须 | 40 | 机构签约代扣来源渠道
PUBLICPLATFORM:服务窗 |
PUBLICPLATFORM |
agent_code | String | 必须 | 20 | 从服务窗发起则为publicId的值 | 123456 |
sign_expire_date | String | 可选 | 20 | 签约到期时间。空表示无限期,一期固定传空。 | 2015-03-12 |
pay_config | String | 可选 | 50 | 支付工具设置,目前可为空 | null |
notify_config | String | 可选 | 50 | 通知方式设置,可为空 | null |
deduct_type | String | 可选 | 20 | 签约类型可为空 | direct_sign_deduct |
extend_field | String | 可选 | 3000 | 扩展字段 | null |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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 | 20141028000363828663 |
sign_date | String | 必填 | 20 | 签约时间 | 2014-01-21 |
pay_config | String [] | 必填 | 50 | 支付方式设置 | BALANCE |
notify_config | String | 必填 | 50 | 通知方式设置。 | 通知方式文案 |
out_agreement_id | String | 必填 | 32 | 商户生成的代扣协议ID | 123123 |
agreement_status | String | 必填 | 10 | 支付宝协议状态。签约成功则返回success | success |
extend_field | String | 必填 | 3000 | 扩展参数,可为空 | null |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayEbppPdeductSignAddRequest request = new AlipayEbppPdeductSignAddRequest(); request.setPayPasswordToken("11505a6f41688644a4b85f9bf80ef071"); request.setUserId("2088111133334134"); request.setBizType("JF"); request.setSubBizType("ELECTRIC"); request.setBillKey("02659981"); request.setOwnerName("王海龙"); request.setPid("2088102118849556"); request.setChargeInst("CQCENTERELECTRIC"); request.setOutAgreementId("123456"); request.setAgentChannel("PUBLICPLATFORM"); request.setAgentCode("123456"); request.setSignExpireDate("2015-03-12"); request.setPayConfig("null"); request.setNotifyConfig("null"); request.setDeductType("direct_sign_deduct"); request.setExtendField("null"); AlipayEbppPdeductSignAddResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "alipay_ebpp_pdeduct_sign_add_response":{ "agreement_id":"20141028000363828663", "pay_config":[ "BALANCE" ], "agreement_status":"success", "sign_date":"2014-01-21", "out_agreement_id":"123123", "extend_field":"null", "notify_config":"通知方式文案" } }
{ "alipay_ebpp_pdeduct_sign_add_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
错误码 | 错误描述 | 解决方案 |
---|---|---|
isv.arguments-error | 参数不合法 | 参数不合法 |
isp.unknow-error | 支付宝系统未知异常 | 支付宝系统未知异常 |
isv.charge-no-direct-deduct | 机构不支持代扣 | 机构不支持代扣 |
isv.deduct-user-no-auth | 用户不支持签约 | 用户不支持签约 |
isv.deduct-paypassword-error | 独立密码校验失败 | 独立密码校验失败 |
isv.deduct-balance-is-not-payment | 用户余额支付功能已关闭 | 用户余额支付功能已关闭 |
isv.deduct-deplicated-self | 抱歉,你已经签约该户号 | 抱歉,你已经签约该户号 |
isv.deduct-sign-no-exist | 用户签约不存在 | 用户签约不存在 |
isv.deduct-billkey-sign-exit | 此户号已经被签约 | 此户号已经被签约 |
isv.deduct-no-autherity-by-realnamed | 用户未实名认证,不可以使用 | 用户未实名认证,不可以使用 |
isv.deduct-no-autherity-by-q | Q用户不可以使用 | Q用户不可以使用 |