alipay.user.agreement.query(支付宝个人代扣协议查询接口) 在线调试(沙箱环境)

支付宝个人代扣协议查询接口

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
personal_product_code String 可选 64 协议产品码,商户和支付宝签约时确定,商户可咨询技术支持。 GENERAL_WITHHOLDING_P
alipay_user_id String 可选 32 用户的支付宝账号对应 的支付宝唯一用户号,以 2088 开头的 16 位纯数字 组成;
本参数与 alipay_logon_id 不 可同时为空,若都填写,则 以本参数为准,优先级高于 alipay_logon_id。
2088101122675263
alipay_logon_id String 可选 100 用户的支付宝登录账号,支持邮箱或手机号码格式。本参数与alipay_user_id 不可同时为空,若都填写,则以alipay_user_id 为准。 abx@alitest.com
sign_scene String 可选 64 签约协议场景,商户和支付宝签约时确定,商户可咨询技术支持。
当传入商户签约号 external_sign_no 时,场景不能为空或默认值 DEFAULT|DEFAULT。
该值需要与系统/页面签约接口调用时传入的值保持一 致。
INDUSTRY|MEDICAL
external_agreement_no String 可选 32 代扣协议中标示用户的唯一签约号(确保在商户系统中
唯一)。
格式规则:支持大写小写字 母和数字,最长 32 位。
test
third_party_type String 可选 32 签约第三方主体类型。对于三方协议,表示当前用户和哪一类的第三方主体进行签约。
取值范围:
取值范围:
1. PARTNER(平台商户);
2. MERCHANT(集团商户),集团下子商户可共享用户签约内容;
默认为PARTNER。
PARTNER
agreement_no String 可选 64 支付宝系统中用以唯一标识用户签约记录的编号(用户签约成功后的协议号 ) ,如果传了该参数,其他参数会被忽略 20170322450983769228

响应参数

参数 类型 是否必填 最大长度 描述 示例值
valid_time String 必填 32 协议生效时间,格式为 yyyy-MM-dd HH:mm:ss。 2017-05-24 15:00:40
alipay_logon_id String 必填 100 返回脱敏的支付宝账号 test***ali@alipay.net
invalid_time String 必填 32 协议失效时间,格式为 yyyy-MM-dd HH:mm:ss。 2117-05-24 00:00:00
pricipal_type String 必填 10 签约主体类型。
CARD:支付宝账号
CUSTOMER:支付宝用户
CARD
device_id String 选填 256 设备Id RSED235F875932
principal_id String 必填 32 签约主体标识。
当principal_type为CARD 时,该字段为支付宝用户号;
当principal_type为 CUSTOMER 时,该字段为支付宝用户标识。一个用户 可能有多个支付宝账号,即多个支付宝用户号,但只有一个是支付宝用户标识。
一个支付宝账号对应一个支付宝唯一用户号(以2088开头的16位纯数字组成)。
2088101122675263
sign_scene String 必填 64 签约协议的场景。 INDUSTRY|CARRENTAL
agreement_no String 必填 64 用户签约成功后的协议号 20170322450983769228
third_party_type String 必填 32 签约第三方主体类型。对于三方协议,表示当前用户和哪一类的第三方主体进行签约。
取值范围:
1. PARTNER(平台商户);
2. MERCHANT(集团商户),集团下子商户可共享用户签约内容;
默认为PARTNER。
PARTNER
status String 必填 32 协议当前状态
1. TEMP:暂存,协议未生效过;
2. NORMAL:正常;
3. STOP:暂停
NORMAL
sign_time String 必填 32 协议签约时间,格式为 yyyy-MM-dd HH:mm:ss。 2017-05-24 15:00:40
personal_product_code String 必填 64 协议产品码,商户和支付宝签约时确定,不同业务场景对应不同的签约产品码。 GENERAL_WITHHOLDING_P
external_agreement_no String 选填 32 代扣协议中标示用户的唯一签约号(确保在商户系统中唯一) test
zm_open_id String 选填 64 用户的芝麻信用 openId,供商 户查询用户芝麻信用使用。 268816057852461313538942792
external_logon_id String 选填 100 外部登录Id 2088101118392209
credit_auth_mode String 选填 32 授信模式,取值:DEDUCT_HUAZHI-花芝GO。目前只在花芝代扣(即花芝go)协议时才会返回 DEDUCT_HUAZHI

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayUserAgreementQueryRequest request = new AlipayUserAgreementQueryRequest();
request.setBizContent("{" +
"\"personal_product_code\":\"GENERAL_WITHHOLDING_P\"," +
"\"alipay_user_id\":\"2088101122675263\"," +
"\"alipay_logon_id\":\"abx@alitest.com\"," +
"\"sign_scene\":\"INDUSTRY|MEDICAL\"," +
"\"external_agreement_no\":\"test\"," +
"\"third_party_type\":\"PARTNER\"," +
"\"agreement_no\":\"20170322450983769228\"" +
"  }");
AlipayUserAgreementQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_user_agreement_query_response": {
        "code": "10000",
        "msg": "Success",
        "valid_time": "2017-05-24 15:00:40",
        "alipay_logon_id": "test***ali@alipay.net",
        "invalid_time": "2117-05-24 00:00:00",
        "pricipal_type": "CARD",
        "device_id": "RSED235F875932",
        "principal_id": "2088101122675263",
        "sign_scene": "INDUSTRY|CARRENTAL",
        "agreement_no": "20170322450983769228",
        "third_party_type": "PARTNER",
        "status": "NORMAL",
        "sign_time": "2017-05-24 15:00:40",
        "personal_product_code": "GENERAL_WITHHOLDING_P",
        "external_agreement_no": "test",
        "zm_open_id": "268816057852461313538942792",
        "external_logon_id": "2088101118392209",
        "credit_auth_mode": "DEDUCT_HUAZHI"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
USER_NOT_EXIST_ERROR 用户信息不存在 检查用户信息是否正确
PRODUCT_CODE_NOT_SUPPORTED_ERROR 无效的个人产品码 商户确认个人产品码填写是否正确
USER_AGREEMENT_NOT_EXIST 用户协议不存在 检查用户协议是否正确
INVALID_PARAMETER 参数有误 参数错误,请确认传参是否正确
SYSTEM_ERROR 系统繁忙 系统繁忙,需排查具体原因
AUTHOREE_IS_NOT_MATCH 被授权方不匹配 确认商户app_id对应的被授权方与用户协议中的被授权方是否一致
USER_NOT_EXSIT_ERROR 用户信息不存在 检查用户信息是否正确
onlineServer