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

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/user/agreement/unsign' \ --header 'Content-Type: application/json' \ --data-raw '{ "agreement_no": "20170322450983769228", "alipay_logon_id": "abx@alitest.com", "alipay_open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "alipay_user_id": "2088101143488930", "extend_params": "{\"UNSIGN_ERROR_CODE\": \"USER_OWE_MONEY\",\"UNSIGN_ERROR_INFO\":\"10.00\"}", "external_agreement_no": "test", "notify_url": "string", "operate_type": "confirm", "personal_product_code": "GENERAL_WITHHOLDING_P", "sign_scene": "INDUSTRY|MEDICA", "third_party_type": "PARTNER" }'

请求参数

Body 参数application/json

agreement_no

string

可选

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

示例值:

20170322450983769228

alipay_logon_id

string

可选

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

示例值:

abx@alitest.com

alipay_open_id

string

可选

用户的支付宝账号对应的支付宝唯一用户号，本参数与alipay_logon_id 不可同时为空，若都填写，则以本参数为准，优先级高于alipay_logon_id。

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

alipay_user_id

string

可选

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

示例值:

2088101143488930

extend_params

string

扩展参数

可选

示例值:

{"UNSIGN_ERROR_CODE": "USER_OWE_MONEY","UNSIGN_ERROR_INFO":"10.00"}

external_agreement_no

string

可选

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

示例值:

test

notify_url

string

通知地址

可选

operate_type

string

可选

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

示例值:

confirm

personal_product_code

string

可选

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

示例值:

GENERAL_WITHHOLDING_P

sign_scene

string

可选

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

示例值:

INDUSTRY|MEDICA

third_party_type

string

可选

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

示例值:

PARTNER

示例

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

请求参数

返回响应