支付宝个人代扣协议解约接口 -凯发app官方网站

支持第三方代理调用

更新时间：2024-12-10 18:38:43

文档更新记录 >

订阅更新

我的文档

设置

通用场景

支付宝个人代扣协议解约接口

公共请求参数

参数	类型	是否必选	最大长度	描述	示例值
app_id	string	必选	32	支付宝分配给开发者的应用id	2014072300007148
method	string	必选	128	接口名称	alipay.user.agreement.unsign
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
notify_url	string	可选	256	支付宝服务器主动通知商户服务器里指定的页面http/https路径。	http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token	string	可选	40	详见应用授权概述
biz_content	string	必选		请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

业务请求参数

以下参数三选一传入

alipay_user_idstring(32)

【描述】用户的支付宝账号对应的支付宝唯一用户号，以2088 开头的 16 位纯数字组成; 本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。

新商户建议使用alipay_open_id替代该字段。对于新商户，alipay_user_id字段未来计划逐步回收，存量商户可继续使用。如使用alipay_open_id，请确认应用-开发配置-openid配置管理已启用。无该配置项，可查看openid配置申请。

【示例值】2088101143488930

alipay_open_idstring(128)

【描述】用户的支付宝账号对应的支付宝唯一用户号，本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。详情可查看 openid简介

【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5

alipay_logon_idstring(100)

【描述】用户的支付宝登录账号，支持邮箱或手机号码格式。本参数与alipay_user_id 不可同时为空，若都填写，则以alipay_user_id 为准。

【示例值】abx@alitest.com

以下参数二选一传入

external_agreement_nostring(32)

【描述】代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。格式规则:支持大写小写字母和数字，最长 32 位。注意：若调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时传入 external_agreement_no 则该值必填且需与签约接口传入值相同。

【示例值】test

agreement_nostring(64)

【描述】支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号），如果传了该参数，其他参数会被忽略。本参数与 external_agreement_no 不可同时为空。

【示例值】20170322450983769228

personal_product_code特殊可选string(64)

【描述】协议产品码，商户和支付宝签约时确定，不同业务场景对应不同的签约产品码。

【示例值】general_withholding_p

sign_scene特殊可选string(64)

【描述】签约协议场景，该值需要与系统/页面签约接口调用时传入的值保持一致。如：周期扣款场景，需与调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时的 sign_scene 相同。当传入商户签约号 external_agreement_no时，场景不能为空或默认值 default|default。

【示例值】industry|medica

third_party_type｜签约第三方主体类型可选string(32)

【描述】签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。

【枚举值】

平台商户: partner

【注意事项】默认为partner

【示例值】partner

extend_params可选string(512)

【描述】扩展参数

【示例值】{"unsign_error_code": "user_owe_money","unsign_error_info":"10.00"}

operate_type可选string(10)

【描述】注意：仅异步解约需传入，其余情况无需传递本参数。

【枚举值】

解约确认: confirm

解约作废: invalid

【示例值】confirm

参数	类型	是否必选	最大长度	描述	示例值
alipay_user_id	string	三选一	32	用户的支付宝账号对应的支付宝唯一用户号，以2088 开头的 16 位纯数字组成; 本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。新商户建议使用alipay_open_id替代该字段。对于新商户，alipay_user_id字段未来计划逐步回收，存量商户可继续使用。如使用alipay_open_id，请确认应用-开发配置-openid配置管理已启用。无该配置项，可查看openid配置申请。	2088101143488930
alipay_open_id	string		128	用户的支付宝账号对应的支付宝唯一用户号，本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。详情可查看 openid简介	074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
alipay_logon_id	string		100	用户的支付宝登录账号，支持邮箱或手机号码格式。本参数与alipay_user_id 不可同时为空，若都填写，则以alipay_user_id 为准。	abx@alitest.com
personal_product_code	string	特殊可选	64	协议产品码，商户和支付宝签约时确定，不同业务场景对应不同的签约产品码。	general_withholding_p
sign_scene	string	特殊可选	64	签约协议场景，该值需要与系统/页面签约接口调用时传入的值保持一致。如：周期扣款场景，需与调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时的 sign_scene 相同。当传入商户签约号 external_agreement_no时，场景不能为空或默认值 default\|default。	industry\|medica
external_agreement_no	string	二选一	32	代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。格式规则:支持大写小写字母和数字，最长 32 位。注意：若调用 alipay.user.agreement.page.sign(支付宝个人协议页面签约接口) 签约时传入 external_agreement_no 则该值必填且需与签约接口传入值相同。	test
agreement_no	string	二选一	64	支付宝系统中用以唯一标识用户签约记录的编号（用户签约成功后的协议号），如果传了该参数，其他参数会被忽略。本参数与 external_agreement_no 不可同时为空。	20170322450983769228
third_party_type	string	可选	32	签约第三方主体类型。对于三方协议，表示当前用户和哪一类的第三方主体进行签约。枚举值平台商户: partner 注意事项默认为partner	partner
extend_params	string	可选	512	扩展参数	{"unsign_error_code": "user_owe_money","unsign_error_info":"10.00"}
operate_type	string	可选	10	注意：仅异步解约需传入，其余情况无需传递本参数。枚举值解约确认: confirm 解约作废: invalid	confirm

常见请求示例

默认示例

curljavac#php

curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.user.agreement.unsign&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'app_auth_token=${app_auth_token}' \
 -f 'biz_content={
	"alipay_user_id":"2088101143488930",
	"alipay_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
	"alipay_logon_id":"abx@alitest.com",
	"personal_product_code":"general_withholding_p",
	"sign_scene":"industry|medica",
	"external_agreement_no":"test",
	"agreement_no":"20170322450983769228",
	"third_party_type":"partner",
	"extend_params":"{\"unsign_error_code\": \"user_owe_money\",\"unsign_error_info\":\"10.00\"}",
	"operate_type":"confirm"
}'

说明：本示例仅供参考。

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	string	必选	-	网关返回码,	40004
msg	string	必选	-	网关返回码描述,	business failed
sub_code	string	可选	-	业务返回码，参见具体的api接口文档	acq.trade_has_success
sub_msg	string	可选	-	业务返回码描述，参见具体的api接口文档	交易已被支付
sign	string	必选	-	签名,	dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

无业务响应参数

响应示例

正常示例

异常示例

{
    "alipay_user_agreement_unsign_response": {
        "code": "10000",
        "msg": "success"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}

说明：本示例仅供参考。

公共错误码

业务错误码

错误码	错误描述	凯发app官方网站的解决方案
system_error	系统繁忙	服务器异常可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
invalid_parameter	参数有误	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试
agreement_not_exist	用户协议不存在	协议不存在，确认用户是否与商户、支付宝签约三方协议
agreement_not_exsit	协议不存在	确认用户是否与商户、支付宝签约三方协议
authoree_is_not_match	被授权方不匹配	确认商户app_id对应的被授权方与用户协议中的被授权方是否一致
illegal_params	参数错误	参数错误，请确认传参是否正确
merchant_agreement_is_not_exist	商户协议不存在	请确认商户是否有签约合同
product_code_not_supported_error	无效的个人产品码	商户确认个人产品码填写是否正确
user_agreement_query_fail	用户协议查询失败	用户协议查询失败
user_agreement_status_is_not_normal	协议状态非法	异步解约场景，如果作废解约请求时遇到此错误码，说明对应协议非解约中状态，建议查询对应协议确认最新状态
user_agreement_status_not_normal	用户协议状态不正常	检查用户协议状态有效性
user_agreement_unsign_fail	用户协议解约失败	用户协议解约失败
user_not_exist_error	支付宝用户信息不存在	用户不存在，检查用户信息正确性
user_not_exsit_error	用户信息不存在	检查用户信息是否正确

触发通知示例

https://www.merchant.com/receive_notify.htm?notify_id=91722adff935e8cfa58b3aabf4dead6ibe¬ify_time=2017-02-16 21:46:15&sign_type=rsa2&sign=wco t3d8kg71dtlkwn7r9pzuoxeabjwp8/fousxcuskxsovyxbpsaidpryscjhcjmaglncjokjqlj28/asl93jotw39fx6i07lxhnbpknezalwmvpdnqui01hzszf9v1i6ggzjbiad5lg8bzttxzoj87ub2i9guj3nr/nuc9vey=&app_id=2017060101317939&auth_app_id=2017060101317935&alipay_logon_id=test***ali@alipay.net&agreement_no=20170502000610755993&alipay_user_id=2088101143488930&alipay_open_id=031_dffvt0ufzk1852blpnhuswiztu4nqbko35ylxpow-y6&merchant_app_id=2014072300007148¬ify_type=dut_user_unsign&external_agreement_no=test&external_logon_id=13852852877&personal_product_code=general_withholding_p&sign_scene=industry|carrental&status=unsign&unsign_time=2017-05-20 11:49:19&credit_auth_mode=deduct_huazhi

设置阅读模式