缴费直连代扣签约

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/ebpp/pdeduct/sign/add' \ --header 'Content-Type: application/json' \ --data-raw '{ "agent_channel": "PUBLICPLATFORM", "agent_code": "123456", "bill_key": "02659981", "biz_type": "JF", "charge_inst": "CQCENTERELECTRIC", "deduct_prod_code": "INSURANCE_MERCHANT_DEDUCT", "deduct_type": "direct_sign_deduct", "ext_user_info": "{\"name\":\"张三\",\"cert_type\":\"IDENTITY_CARD\",\"cert_no\":\"362334768769238881\",\"need_check_info\":\"F\",\"min_age\":\"18\",\"mobile\":\"\"}", "extend_field": "null", "notify_config": "null", "open_id": "074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5", "out_agreement_id": "123456", "owner_name": "王海龙", "pay_config": "null", "pay_password_token": "11505a6f41688644a4b85f9bf80ef071", "pid": "2088102118849556", "sub_biz_type": "ELECTRIC", "user_id": "2088111133334134", "sign_expire_date": {} }'

{ "agreement_id": "20141028000363828663", "agreement_status": "success", "extend_field": "null", "notify_config": "通知方式文案", "out_agreement_id": "123123", "pay_config": "BALANCE", "sign_date": {} }

请求参数

Body 参数application/json

agent_channel

string

可选

机构签约代扣来源渠道 PUBLICPLATFORM：服务窗

示例值:

PUBLICPLATFORM

agent_code

string

可选

从服务窗发起则为publicId的值

示例值:

123456

bill_key

string

可选

户号，机构针对于每户的水、电都会有唯一的标识户号

示例值:

02659981

biz_type

string

可选

业务类型。枚举支持： *JF：公共事业缴纳。 *WUYE：物业缴费。 *HK：信用卡还款。 *TX：通讯缴费。 *IND：保险缴费。

示例值:

charge_inst

string

可选

支付宝缴费系统中的出账机构ID

示例值:

CQCENTERELECTRIC

deduct_prod_code

string

可选

代扣产品码。缴费业务场景中，传入INST_DIRECT_DEDUCT。保险业务场景中, 传入INSURANCE_MERCHANT_DEDUCT。

示例值:

INSURANCE_MERCHANT_DEDUCT

deduct_type

string

签约类型可为空

可选

示例值:

direct_sign_deduct

ext_user_info

string

可选

外部用户实名认证相关信息, 用于做签约时的实名校验。注：

name: 姓名 cert_type: 身份证：IDENTITY_CARD、护照：PASSPORT、军官证：OFFICER_CARD、士兵证：SOLDIER_CARD、户口本：HOKOU等 cert_no: 证件号码 need_check_info取值 T/F，只有为T时才做强制校验。 mobile:手机号，目前暂不使用此字段做校验 min_age: 允许的最小买家年龄,min_age为整数，必须大于等于0.

示例值:

{"name":"张三","cert_type":"IDENTITY_CARD","cert_no":"362334768769238881","need_check_info":"F","min_age":"18","mobile":""}

extend_field

string

扩展字段

可选

示例值:

null

notify_config

string

可选

通知方式设置，可为空

示例值:

null

open_id

string

可选

用户UserId在应用AppId下的唯一用户标识

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

out_agreement_id

string

外部产生的协议ID

可选

示例值:

123456

owner_name

string

户名，户主真实姓名

可选

示例值:

王海龙

pay_config

string

可选

支付工具设置，目前可为空

示例值:

null

pay_password_token

string

可选

支付密码鉴权token，需要用户首先处于登陆态，然后访问https://ebppprod.alipay.com/deduct/enterMobileicPayPassword.htm?cb=自己指定的回跳连接地址，访问页面后会进到独立密码校验页，用户输入密码校验成功后，会生成token回调到指定的回跳地址，如果设置cb=www.alipay.com则最后回调的内容是www.alipay.com?token=312314ADFDSFAS，然后签约时直接取得地址后token的值即可。

示例值:

11505a6f41688644a4b85f9bf80ef071

pid

string

可选

商户id，商户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。

示例值:

2088102118849556

sub_biz_type

string

可选

业务子类型。业务子类型是业务类型的下一级概念。枚举支持： *WATER：缴水费。 *ELECTRIC：缴电费。 *GAS：缴燃气费。 *COMMUN：缴固话宽带费。 *CATV：缴有线电视费。 *TRAFFIC：缴交通罚款。 *WUYE：缴物业费。 *RC：定期还车贷代扣。 *RH：定期还房贷代扣。 *RR：定期还房租代扣。 *RN：定期还网贷代扣。 *CZ：手机充值代扣。 *CAR：车险。 *LIFE：寿险。 *HEALTH：健康险。例如：WATER表示JF下面的水费。

示例值:

ELECTRIC

user_id

string

可选

用户 id，用户在支付宝的唯一标识，以 2088 开头的 16 位纯数字组成。

示例值:

2088111133334134

sign_expire_date

string

可选

签约到期时间。空表示无限期，一期固定传空。

示例值:

{}

示例

返回响应

🟢200common response

application/json

Body

agreement_id

string

支付宝代扣协议ID

可选

示例值:

20141028000363828663

agreement_status

string

可选

支付宝协议状态。签约成功则返回success

示例值:

success

extend_field

string

扩展参数，可为空

可选

示例值:

null

notify_config

string

通知方式设置。

可选

示例值:

通知方式文案

out_agreement_id

string

可选

商户生成的代扣协议ID

示例值:

123123

pay_config

array[string]

支付方式设置

可选

示例值:

BALANCE

sign_date

string

签约时间

可选

示例值:

{}

🔴500请求失败