支付宝个人协议页面签约接口
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v3/alipay/user/agreement/page/sign
错误码
公共错误码
业务错误码
| 状态码 | 错误码 | 错误描述 | 解决方案 |
|---|---|---|---|
| 400 | ERROR_RISK_ACCOUNT_FROZEN | 用户账户被冻结 | 提示用户解冻支付宝账号 |
| 400 | ERROR_RISK_BLANCE_PAY_CLOSE | 用户账号余额支付功能关闭 | 提示用户支付宝账号打开余额支付功能 |
| 400 | USER_ACCOUNT_NOT_BINDED_MOBILE | 用户账户未绑定手机 | 提示用户支付宝账号绑定手机号 |
| 400 | MERCHANT_AGREEMENT_IS_NOT_EXIST | 商户协议不存在 | 商户与 支付宝签约代扣合同 |
| 400 | PRODUCT_CODE_NOT_SUPPORTED_ERROR | 无效的个人产品码 | 商户确认个人产品码填写是否正确 |
| 400 | USER_AGREEMENT_PERIOD_CONFILICT | 协议已存在，协议有效周期冲突 | 接口填入的协议有效期与已签约的协议有效期冲突，需填入已存协议的有效期 |
| 400 | USER_REALNAME_STAUTS_ERROR | 用户未实名不允许签约 | 提示用户补充支付宝账号信息完成实名制 |
| 400 | ACCOUNT_LEVEL_CHECK_FAIL | 用户账户等级不满足签约要求 | 提示用户在支付宝主站提高个人支付宝账户等级 |
| 400 | ZHIMA_SCORE_VALIDATE_FAILED | 用户芝麻分校验失败 | 信用代扣场景，用户芝麻分不满足商户设定的签约芝麻分 |
| 400 | ZHIMA_AUTHORIZE_FAILED | 芝麻授权开通失败 | 信用代扣场景，授权开通芝麻失败，需与芝麻共同排查原因 |
| 400 | ZHIMA_RISK_VALIDATE_FAILED | 芝麻风险名单校验失败 | 信用代扣场景，用户支付宝账号未通过芝麻风险名单校验 |
| 400 | USER_INFO_NOT_MATCH | 外部签约号已签约场景，用户信息不匹配 | 商户更改外部签约号 |
| 400 | MERCHANT_STATUS_IS_NOT_NORMAL | 商户协议状态不正常 | 商户确认与支付宝的签约合同是否已失效，并重新签约商户合同 |
| 400 | MERCHANT_AGREEMENT_OUT_OF_DATE | 商户协议已过期 | 商户确认与支付宝的合同的有效期是否已过期，并重新签约商户合同 |
| 400 | MAX_SIGN_COUNT_CHECK_FAIL | 用户最大签约次数检查失败 | 用户在该商户下已签约的协议数达到商户允许的最大签约协议数量，无法继续签约 |
| 400 | INVALID_PARAMETER | 参数有误参数有误 | 参数错误，请确认传参是否正确 |
| 400 | SYSTEM_ERROR | 系统繁忙 | 系统繁忙，需排查具体原因 |
| 400 | USER_NOT_ALLOW_FOREX_ELIGIBLE | 用户不具备海外购汇身份信息 | 需用户补全海外购汇身份信息 |
| 400 | BUSINESS_NOT_SUPPORTED_ERROR | 不支持的业务 | 商户确认传入业务参数是否符合业务要求 |
| 400 | USER_MOBILE_NOT_MATCH_ERROR | 用户手机号不匹配 | 商户传入的手机号与用户支付宝绑定的手机号不一致 |
| 400 | ERROR_RIST_CTU_REFUSE | 操作存在风险，被CTU拒绝 | 确认用户的具体操作风险 |
| 400 | USER_NOT_EXIST_ERROR | 用户信息不存在 | 无法查到用户信息，确认用户信息是否存在 |
| 400 | USER_ACCOUNT_NOT_EXIST | 用户账户信息不存在 | 无法查到用户账户信息，确认用户账户信息是否存在 |
| 400 | SECURITY_CHECK_FAIL | 操作存在风险 | 签约操作存在风险，需与支付宝确认具体被拦截原因 |
| 400 | VALIDATECODE_EXPIRED | 校验码超时 | 校验码超时，请重新获取 |
| 400 | SIGN_USER_ID_NOT_MATCH | 签约账号不匹配 | 用户根据错误页面上提示的支付宝账号重新登录签约 |
| 400 | USER_AGE_RANGE_NOT_MATCH | 不在商户业务允许的年龄范围 | 提示用户的年龄不在商户业务允许的年龄范围，无法继续签约 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/user/agreement/page/sign' \
--header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \
--header 'alipay-request-id: $requestid' \
--header 'Content-Type: application/json' \
--data-raw '{
"notify_url":"http://api.test.alipay.net/atinterface/receive_notify.htm",
"product_code":"GENERAL_WITHHOLDING",
"external_logon_id":"13852852877",
"personal_product_code":"GENERAL_WITHHOLDING_P",
"sign_scene":"INDUSTRY|CARRENTAL",
"external_agreement_no":"test",
"third_party_type":"PARTNER",
"sign_validity_period":"2m",
"zm_auth_params":{
"buckle_app_id":"1001164",
"buckle_merchant_id":"268820000000414397785"
},
"prod_params":{
"auth_biz_params":"{\"platform\":\"taobao\"}"
},
"promo_params":"{\"key\":\"value\"}",
"access_params":{
"channel":"ALIPAYAPP"
},
"sub_merchant":{
"sub_merchant_id":"2088123412341234",
"sub_merchant_name":"滴滴出行",
"sub_merchant_service_name":"滴滴出行免密支付",
"sub_merchant_service_description":"免密付车费，单次最高500"
},
"device_params":{
"device_id":"device12345",
"device_name":"电视",
"device_type":"TV"
},
"identity_params":{
"user_name":"张三",
"cert_no":"61102619921108888",
"identity_hash":"8D969EEF6ECAD3C29A3A629280E686CF0C3F5D5A86AFF3CA12020C923ADC6C92",
"sign_user_id":"2088202888530893"
},
"agreement_effect_type":"DIRECT",
"user_age_range":"{\"min\":\"18\",\"max\":\"30\"}",
"period_rule_params":{
"period_type":"DAY",
"period":3,
"execute_time":"2019-01-23",
"single_amount":10.99,
"total_amount":600,
"total_payments":12
},
"effect_time":300
}'响应示例响应示例
200 - 成功示例
{
"alipay_user_id": "2088101143488930",
"external_agreement_no": "test",
"personal_product_code": "GENERAL_WITHHOLDING_P",
"valid_time": "2017-05-20 11:49:19",
"sign_scene": "INDUSTRY|CARRENTAL",
"agreement_no": "20170502000610755993",
"zm_open_id": "268816057852461313538942792",
"invalid_time": "2017-05-20 11:49:19",
"sign_time": "2017-05-20 11:49:19",
"status": "NORMAL",
"forex_eligible": "T",
"external_logon_id": "13852852877",
"alipay_logon_id": "test***ali@alipay.net",
"credit_auth_mode": "DEDUCT_HUAZHI"
}请求参数
Header 参数
authorization
string
必需
示例值:
ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign
alipay-request-id
string
必需
示例值:
$requestid
Content-Type
string
必需
示例值:
application/json
Body 参数application/json