4.9.6业务参数(bizdata)字段描述

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	int64	标记每一次请求的流水
company_id	缴费单位编号	微信申请分配	是	32
openid	用户id		是	40
bill_key	户号		是	64
tel_no	手机号		否	32
cert_no	身份证号		否	128
cert_name	姓名		否	128
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	int64	标记每一次请求的流水
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败 PARAM_ERROR:参数错误 SIGN_ERROR:签名错误 FAIL：其他异常	是	10
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

2.查询代扣配置通知接口

请求参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号		是	int64	标记每一次请求的流水
company_id	缴费单位编号	微信申请分配	是	32
openid	用户id		是	40
bill_key	户号		是	64
customer_name	户名		是	64
customer_addr	用户地址		是	256
account_type	账户类型	prepaid：预付费；postpaid:后付费；fixed:固定时间扣费	是	16	用以标识代扣类型，预付费：账户低于x元，自动充值y元；后付费：已经出账金额自动缴纳；固定时间扣费：每月的a日，充值b元
current_sign_channel	当前用户的签约渠道	当前用户签约渠道	否	32	如xx银行代扣
charge_limit_amount	充值限额	单位分，预付费必填，低于该金额扣费xx金额	否	int
charge_amount	充值金额	单位分，预付费必填，低于充值限额扣该充值金额	否	int
charge_limit_amount_modify	充值限额是否可修改	Y：可修改 N:不可修改	否	1
charge_amount_modify	充值金额是否可修改	Y：可修改 N:不可修改	否	1
charge_day	扣费日期	1代表每月1号扣费数字 1-31	否	int
charge_day_modify	扣费日期是否可修改	Y：可修改 N:不可修改	否	1
replace_remind	代扣覆盖提醒	服务将自动覆盖 N或者不填：可直接办理，无需提醒	否	1
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 FAIL：其他异常 SIGNED_OTHER：该户号已被其他用户签约（不支持签约） SIGNED_CHANNEL:该户号已通过其他渠道签约（不支持签约） NO_EXIST：户号不存在 SIGN_RULE_FAIL:依据相关规则，该户号暂不支持签约 SIGN_LOCKED:处于代扣期间（或已锁定），在此期间暂不支持签约	是	16
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	64	标记每一次请求的流水
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败 PARAM_ERROR:参数错误 SIGN_ERROR:签名错误 FAIL：其他异常 ALREADY_PROCESS:已处理，请勿重复提交	是	10
return_msg	提示信息		是	20
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

3.申请签约/解约接口

接口说明：

商户的公众号/小程序/h5/APP通过调用该接口打开生活缴费小程序，进入申请签约/解约页面。

自动缴费支持三种模式，申请签约时填写信息要求不同：

预付费模式：缴费额度和低于限额缴费字段必填，每月缴费日期不填

后付费模式：缴费额度、低于限额缴费和每月缴费日期均不填

固定日期缴固定金额模式：缴费额度和每月缴费日期必填，低于限额缴费不填

请求参数：

参数	参数名称	取值	必填	最大长度	备注
company_id	缴费单位编号	微信申请分配	是	32
serial_no	流水号		是	int	标记每一次请求的流水
openid	用户id		是	40
bill_key	户号		是	64
change_type	变更类型	ADD--签约 DELETE--解约	是	8
contract_termination_mod	解约方式	1-单户号解约 2-商户平台解约	否	int	当change_type为DELETE时使用
account_type	账户类型	prepaid：预付费；postpaid:后付费；fixed:固定时间扣费	是	16	用以标识代扣类型，预付费：账户低于x元，自动充值y元；后付费：已经出账金额自动缴纳；固定时间扣费：每月的a日，充值b元
charge_limit_amount	充值限额	单位分，预付费必填，低于该金额扣费xx金额	否	int
charge_amount	充值金额	单位分，预付费必填，低于充值限额扣该充值金额	否	int
charge_day	扣费日期	1代表每月1号扣费数字 1-31	否	int
tel_no	手机号		否	32
cert_no	身份证号		否	128
cert_name	姓名		否	128
extend1	预留字段		否	128
extend2	预留字段		否	128
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	64	标记每一次请求的流水
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败 PARAM_ERROR:参数错误 SIGN_ERROR:签名错误 FAIL：其他异常	是	10
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

4.申请签约/解约结果回调通知接口

请求参数：

参数	参数名称	取值	必填	最大长度	备注
company_id	缴费单位编号	微信申请分配	是	32
serial_no	流水号		是	64	标记每一次请求的流水
openid	用户id		是	40
bill_key	户号		是	64
change_type	变更类型	ADD--签约 DELETE--解约	是	8
return_code	返回码	错误码有以下几种取值： SUCCESS：成功 FAIL：失败 SIGNED_OTHER：该户号已被其他用户签约（不支持签约） SIGN_RULE_FAIL:依据相关规则，该户号暂不支持签约 SIGN_LOCKED:处于代扣期间（或已锁定），在此期间暂不支持签约 PRCESSING:签约或者解约处理中	是	10
return_msg	提示信息		是	64
contract_discount_amount	合约优惠⾦额		否	int	合约⽤户已享受的优惠总⾦额，单位：分
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	int	标记每一次请求的流水
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败 PARAM_ERROR:参数错误 SIGN_ERROR:签名错误 FAIL：其他异常	是	10
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

5.修改签约配置接口

请求参数：

参数	参数名称	取值	必填	最大长度	备注
company_id	缴费单位编号	微信申请分配	是	32
serial_no	流水号		是	int	标记每一次请求的流水
openid	用户id		是	40
bill_key	户号		是	64
account_type	账户类型	prepaid：预付费；postpaid:后付费；fixed:固定时间扣费	是	16	用以标识代扣类型，预付费：账户低于x元，自动充值y元；后付费：已经出账金额自动缴纳；固定时间扣费：每月的a日，充值b元
charge_limit_amount	充值限额	单位分，预付费必填，低于该金额扣费xx金额	否	int
charge_amount	充值金额	单位分，预付费必填，低于充值限额扣该充值金额	否	int
charge_day	扣费日期	1代表每月1号扣费数字 1-31	否	int
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
serial_no	流水号	标识一次整体的签约过程	是	int	标记每一次请求的流水
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败 PARAM_ERROR:参数错误 SIGN_ERROR:签名错误 FAIL：其他异常	是	10
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int	不设置该字段或设置为 0，则为同步模式，修改配置结果以该接⼝返回结果为准；设置为1则为异步模式，同步接⼝返回成功后还需要通过接⼝将配置修改结果通知给⽣活缴费

6.申请代扣扣费接口

请求参数：

参数	参数名称	取值	必填	最大长度	备注
company_id	缴费单位编号	微信申请分配	是	32
openid	用户id		是	40
bill_key	户号		是	64
account_type	账户类型	prepaid：预付费；postpaid:后付费；fixed:固定时间扣费	是	16	用以标识代扣类型，预付费：账户低于x元，自动充值y元；后付费：已经出账金额自动缴纳；固定时间扣费：每月的a日，充值b元
balance	账户余额	单位分，预付费必填	否	int
charge_amount	充值金额	单位分	是	int
channel_bill_no	渠道扣费编号	渠道扣费代扣编号，唯一标识一笔代扣，全局唯一	是	32
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
channel_bill_no	渠道扣费编号	渠道扣费代扣编号，唯一标识一笔代扣，全局唯一	是	32
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败，可相同参数重试 ACCOUNT_TYPE_ERROR:账户类型校验失败 CHECK_LIMIT_CHARGE_AMOUNT_FAIL：充值限额校验失败 CHECK_SIGN_FAIL：签名错误 PARAM_ERROR：参数错误 FAIL：其他异常 CHECK_RSIK_LEVEL_INVALID：风控拦截 NOAUTH：用户已关闭微信代扣功能 NOT_ENOUGH：账户余额不足或暂无可用支付方式 RULELIMIT：扣费金额超出单笔或单月限额接口错误码	是	10
return_msg	提示信息		是	64
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

7.代扣扣费状态查询接口

请求参数：

参数	参数名称	取值	必填	最大长度	备注
company_id	缴费单位编号	微信申请分配	是	32
openid	用户id		是	40
bill_key	户号		是	64
channel_bill_no	渠道扣费编号	渠道扣费代扣编号，唯一标识一笔代扣，全局唯一	是	32
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

返回参数：

参数	参数名称	取值	必填	最大长度	备注
channel_bill_no	渠道扣费编号	渠道扣费代扣编号，唯一标识一笔代扣，全局唯一	是	32
return_code	返回码	错误码有以下几种取值： SUCCESS：请求成功 SYSTEMERROR：系统失败（重试） PARAM_ERROR 参数错误 CHECK_SIGN_FAIL：签名验证失败 ORDERNOTEXIST:订单不存在 FAIL：失败	是	10
return_msg	提示信息		是	64
openid	用户id		是	40
bill_key	户号		是	64
total_fee	订单总金额	单位分	是	int
fee_type	货币种类	CNY	否	8
time_end	支付完成时间	20191031130101	是	32
out_trade_no	商户订单号		是	16
transaction_id	微信支付（银联）订单号		是	32
bank_type	付款银行		否
channel_bill_no	渠道扣费编号	渠道扣费代扣编号，唯一标识一笔代扣，全局唯一	是	32
extend1	预留字段		否	32
trade_state	订单状态	SUCCESS” - 支付成功 “REFUND" - 转入退款 “NOTPAY” - 未支付 “USERPAYING” - 用户支付中（付款码支付） “PAYERROR” - 支付失败(其他原因，如银行返回失败) “OTHER”-其他异常	否	10	支付状态（以最终的对账单为准）
is_sandbox	是否沙箱环境	1：使⽤沙箱环境 0：使⽤正式环境不填默认正式环境	否	int

4.9.6业务参数(bizdata)字段描述

目录

1.查询代扣配置接口

2.查询代扣配置通知接口

3.申请签约/解约接口

4.申请签约/解约结果回调通知接口

5.修改签约配置接口

6.申请代扣扣费接口

7.代扣扣费状态查询接口