alipay.ebpp.pdeduct.sign.validate(缴费直连代扣签约前置校验) 在线调试(沙箱环境)

服务窗代扣签约的前置校验接口,签约前,可以先调用该接口进行校验是否可以签约

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.ebpp.pdeduct.sign.validate
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必选 16 用户支付宝账号id,2088开头16位长度的字符串,在支付宝系统中唯一 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 商户签约支付宝账号的userid,2088开头16位长度的字符串,在支付宝系统中唯一 2088102118849556
charge_inst String 必选 50 支付宝缴费系统中的出账机构ID CQCENTERELECTRIC
out_agreement_id String 可选 32 外部机构签约的协议id 123456
agent_channel String 必选 40 机构签约代扣来源渠道
PUBLICPLATFORM:服务窗
PUBLICPLATFORM
agent_code String 必选 20 从服务窗发起则为该服务窗的appid的值 123456
sign_expire_date String 可选 20 签约到期时间。空表示无限期,一期固定传空。 2015-03-12
pay_config String 可选 50 支付工具设置,目前可为空。类型有:BALANCE;CARTOON;BIGAMOUNT_CREDIT_CARTOON;DEBIT_EXPRESS;OPTIMIZED_MOTO;PCREDIT_PAY;MONEY_FUND null
notify_config String 可选 50 通知方式设置,本期预留字段,固定传空。 null
deduct_type String 可选 20 签约类型,可为空。目前类型有INST_DIRECT_DEDUCT direct_sign_deduct
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");
AlipayEbppPdeductSignValidateRequest request = new AlipayEbppPdeductSignValidateRequest();
request.setBizContent("{" +
"\"user_id\":\"2088111133334134\"," +
"\"biz_type\":\"JF\"," +
"\"sub_biz_type\":\"ELECTRIC\"," +
"\"bill_key\":\"02659981\"," +
"\"owner_name\":\"王龙海\"," +
"\"pid\":\"2088102118849556\"," +
"\"charge_inst\":\"CQCENTERELECTRIC\"," +
"\"out_agreement_id\":\"123456\"," +
"\"agent_channel\":\"PUBLICPLATFORM\"," +
"\"agent_code\":\"123456\"," +
"\"sign_expire_date\":\"2015-03-12\"," +
"\"pay_config\":\"null\"," +
"\"notify_config\":\"null\"," +
"\"deduct_type\":\"direct_sign_deduct\"," +
"\"extend_field\":\"null\"" +
"  }");
AlipayEbppPdeductSignValidateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_ebpp_pdeduct_sign_validate_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
USER_IS_NOT_EXITS 签约的用户id不存在 签约的用户id不存在
NO_AUTHERITY 非T类型的用户不可以签约 非T类型的用户不可以签约
NO_AUTHERITY_BY_REALNAMED 既不是认证用户,也不是实名制用户 既不是认证用户,也不是实名制用户
DEDUCT_BALANCE_IS_NOT_PAYMENT 签约用户余额支付处于关闭状态 签约用户余额支付处于关闭状态
DEDUCT_INST_IS_NOT_EXIST 代扣机构模型不存在 代扣机构模型不存在
DEDUCT_INST_PROD_IS_CLOSED 签约机构产品处于关闭状态 签约机构产品处于关闭状态
DEDUCT_SIGN_DUPLICATED_SELF 当前用户重复签约该户号 当前用户重复签约该户号
DEDUCT_SIGN_DUPLICATED_OTHER 当前户号被别的用户已经签约 当前户号被别的用户已经签约
DEDUCT_SIGN_CTU_CHECK_FAILED 当前用户操作有风险,禁止进行 当前用户操作有风险,禁止进行
INVALID_CARD_NO 支付宝账号非法(帐号不满足签约相关产品) 支付宝账号非法(帐号不满足签约相关产品)
onlineServer