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

{ "agreement_no": "20170322450983769228", "alipay_logon_id": "test***ali@alipay.net", "credit_auth_mode": "DEDUCT_HUAZHI", "device_id": "RSED235F875932", "external_agreement_no": "test", "external_logon_id": "2088101118392209", "personal_product_code": "GENERAL_WITHHOLDING_P", "pricipal_type": "CARD", "principal_id": "2088101122675263", "principal_open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "sign_scene": "INDUSTRY|CARRENTAL", "single_quota": "100.00", "status": "NORMAL", "third_party_type": "PARTNER", "zm_open_id": "268816057852461313538942792", "invalid_time": {}, "last_deduct_time": {}, "next_deduct_time": {}, "sign_time": {}, "valid_time": {} }

请求参数

Query 参数

personal_product_code

string

可选

协议产品码，商户和支付宝签约时确定，商户可咨询技术支持。

alipay_user_id

string

可选

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

alipay_open_id

string

可选

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

alipay_logon_id

string

可选

用户的支付宝登录账号，支持邮箱或手机号码格式。本参数与alipay_open_id 或 alipay_user_id 同时填写，优先按照 alipay_open_id 或 alipay_user_id 处理。

sign_scene

string

可选

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

external_agreement_no

string

可选

代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。格式规则:支持大写小写字母和数字，最长 32 位。

third_party_type

string

可选

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

agreement_no

string

可选

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

返回响应

🟢200common response

application/json

Body

agreement_no

string

可选

用户签约成功后的协议号

示例值:

20170322450983769228

alipay_logon_id

string

可选

返回脱敏的支付宝账号

示例值:

test***ali@alipay.net

credit_auth_mode

string

可选

授信模式，目前只在花芝代扣（即花芝go）协议时才会返回

示例值:

DEDUCT_HUAZHI

device_id

string

设备Id

可选

示例值:

RSED235F875932

external_agreement_no

string

可选

代扣协议中标示用户的唯一签约号(确保在商户系统中唯一)。当入参中传了此参数时返回。

示例值:

test

external_logon_id

string

可选

外部登录Id。当入参中传了此参数时返回。

示例值:

2088101118392209

personal_product_code

string

可选

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

示例值:

GENERAL_WITHHOLDING_P

pricipal_type

string

签约主体类型。

可选

示例值:

CARD

principal_id

string

可选

签约主体标识。当principal_type为CARD 时，该字段为支付宝用户号;

示例值:

2088101122675263

principal_open_id

string

可选

签约主体标识。当principal_type为CARD 时，该字段为支付宝用户号;

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

sign_scene

string

签约协议的场景。

可选

示例值:

INDUSTRY|CARRENTAL

single_quota

string

单笔代扣额度

可选

示例值:

100.00

status

string

可选

协议当前状态

TEMP：暂存，协议未生效过；

NORMAL：正常；

STOP：暂停

示例值:

NORMAL

third_party_type

string

可选

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

示例值:

PARTNER

zm_open_id

string

可选

用户的芝麻信用 openId，供商户查询用户芝麻信用使用。

示例值:

268816057852461313538942792

invalid_time

string

可选

协议失效时间，格式为 yyyy-MM-dd HH:mm:ss。

示例值:

{}

last_deduct_time

string

可选

周期扣协议，上次扣款成功时间

示例值:

{}

next_deduct_time

string

可选

周期扣协议，预计下次扣款时间

示例值:

{}

sign_time

string

可选

协议签约时间，格式为 yyyy-MM-dd HH:mm:ss。

示例值:

{}

valid_time

string

可选

协议生效时间，格式为 yyyy-MM-dd HH:mm:ss。

示例值:

{}

🔴500请求失败