支付宝个人代扣协议查询接口
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://openapi.alipay.com/v3/alipay/user/agreement/query
错误码
公共错误码
业务错误码
| 状态码 | 错误码 | 错误描述 | 解决方案 |
|---|---|---|---|
| 400 | USER_NOT_EXIST_ERROR | 支付宝用户信息不存在 | 检查用户信息是否正确 |
| 400 | PRODUCT_CODE_NOT_SUPPORTED_ERROR | 无效的个人产品码 | 商户确认个人产品码填写是否正确 |
| 400 | USER_AGREEMENT_NOT_EXIST | 用户协议不存在 | 检查用户协议是否正确 |
| 400 | INVALID_PARAMETER | 参数有误参数有误 | 参数错误，请确认传参是否正确 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 系统繁忙， 需排查具体原因 |
| 400 | AUTHOREE_IS_NOT_MATCH | 被授权方不匹配 | 确认商户app_id对应的被授权方与用户协议中的被授权方是否一致 |
| 400 | USER_NOT_EXSIT_ERROR | 用户信息不存在 | 检查用户信息是否正确 |
| 400 | LOGONID_IS_REPEATED | 登录账户名与他人重复 | 登录账户名与他人重复 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 系统繁忙，需排查确认 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 系统繁忙，需排查确认 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 系统繁忙，需排查确认 |
| 400 | AGREEMENT_HAS_UNSIGNED | 用户协议已解约 | 用户于支付宝侧协议已解约，商户需解约对应协议 |
| 400 | INVALID_PARAMETER | 参数有误 | 参数错误，请确认传参是否正确 |
| 400 | PARENT_MERCHANT_QUERY_FAIL | 平台商户查询失败 | 检查父商户是否存在，或重试处理 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 业务属性组信息获取失败，请检查pid、personalproductcode、signscene是否与配置一致或稍后重试 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi.alipay.com/v3/alipay/user/agreement/query?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'响应示例响应示例
200 - 示例 1
{
"principal_id": "string",
"valid_time": "string",
"alipay_logon_id": "string",
"invalid_time": "string",
"pricipal_type": "string",
"device_id": "string",
"sign_scene": "string",
"agreement_no": "string",
"third_party_type": "string",
"status": "string",
"sign_time": "string",
"personal_product_code": "string",
"external_agreement_no": "string",
"zm_open_id": "string",
"external_logon_id": "string",
"credit_auth_mode": "string",
"single_quota": "string",
"last_deduct_time": "string",
"next_deduct_time": "string"
}请求参数
Query 参数
personal_product_code
string
可选
示例值:
GENERAL_WITHHOLDING_P
alipay_user_id
string
可选
示例值:
2088101122675263
alipay_logon_id
string
可选
示例值:
abx@alitest.com
sign_scene
string
可选
示例值:
INDUSTRY|MEDICAL
external_agreement_no
string
可选
示例值:
test
third_party_type
string
可选
枚举值
平台商户: PARTNER
签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。 默认为PARTNER。
枚举值
平台商户: PARTNER
示例值:
PARTNER
agreement_no
string
可选
示例值:
20170322450983769228