代扣类接口

sms003 代扣签约短信发送接口（后台版）

功能说明

适用产品企账通/app+，接口功能说明：给用户的银行卡预留手机号发送短信，需配合代扣签约绑卡确认接口（后台版）或者代扣签约绑卡确认接口（页面版）。

调用方式：后台返回（同步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
版本号 version 定长2位String 必须 固定：10
用户客户号 user_cust_id 定长16位String 可选  
短信订单号 sms_order_id 变长50位String 必须 俗称一阶段订单号
短信订单日期 sms_order_date 定长8位String 必须 俗称二阶段订单号 格式：yyyyMMdd
身份证号 id_card 15位或18位String 可选 用户客户号与身份证号必传其一，优先使用user_cust_id
姓名 user_name 变长50位String 可选 user_cust_id为空时，user_name必传
银行卡号 card_num 变长9-32位String 必须  
银行预留手机号 card_mobile 定长11位String 必须  
省份 card_prov 定长4位String 可选 银行卡开户省份
地区 card_area 定长4位String 可选 银行卡开户地区
绑卡签约类型 bind_type 定长1位String 必须 3：消费分期代扣签约 4：非消费分期代扣签约
产品订单号 product_id 变长20位的String 可选 bind_type=3时，product_id必填 注：代扣订单录入接口的product_id
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
返回码 resp_code 返回码 必须 返回码
返回描述 resp_desc 返回描述 必须 返回描述
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
用户客户号 user_cust_id 定长16位String 必须  
用户账户号 user_acct_id 变长9位String 必须  
短信订单号 sms_order_id 变长50位String 必须  
短信订单日期 sms_order_date 定长8位String 必须 格式：yyyyMMdd
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回码

返回码 返回描述
公共返回码  
H10001 订单已过期
H10003 省份地区非法
H10004 数据加密失败
H10005 银行卡已存在，请勿重复操作
H10028 短信发送频繁
H10031 短信发送失败
H10045 代扣签约只支持借记卡
H10046 产品信息校验失败
H10058 代扣签约只支持个人用户和个体户

bind05 代扣签约确认接口（后台版）

功能说明

适用产品企账通/app+,接口功能说明：用于进行协议代扣签约绑卡，先调用代扣绑卡短信发送接口，再调用此接口验证短信并签约绑卡。本接口不展示协议，使用前需汇付风控审核。解绑请调用银行卡解绑接口。

调用方式：后台返回（同步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
版本号 version 定长2位String 必须 固定：10
订单号 order_id 变长50位String 必须 俗称二阶段订单号 传入“代扣绑卡短信发送”接口的sms_order_id（一阶段二阶段用相同的订单号）
订单日期 order_date 定长8位String 必须 俗称二阶段订单日期 传入“代扣绑卡短信发送”接口的sms_order_date（一阶段二阶段用相同的订单日期） 格式：yyyyMMdd
短信验证码 sms_code 定长6位String 必须  
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
返回码 resp_code 定长6位String 必须 返回码
返回描述 resp_desc 变长128位String 必须 返回描述
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
用户客户号 user_cust_id 定长16位String 必须  
用户账户号 user_acct_id 变长9位String 必须  
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须 格式：yyyyMMdd
短信订单号 sms_order_id 变长50位String 必须  
短信订单日期 sms_order_date 定长8位String 必须 格式：yyyyMMdd
绑卡id bind_card_id 变长20位String 可选 此bind_card_id用于代扣解绑卡接口
签约流水 sign_seq_id 变长30位String 可选 此sign_seq_id用于协议代扣支付接口
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回码

返回码 返回描述
公共返回码  
H10005 银行卡已存在，请勿重复操作
H10029 请重新发送短信
H10030 短信发送中
H10038 订单日期不一致

bind06 代扣签约确认接口（页面版）

功能说明

用于进行协议代扣签约绑卡，先调用代扣绑卡短信发送接口，再调用此接口，然后跳转到代扣协议页面，用户同意签约后，验证短信并签约绑卡。解绑请调用银行卡解绑接口。

调用方式：页面返回（同步，异步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
版本号 version 定长2位String 必须 固定：10
订单号 order_id 变长50位String 必须 俗称二阶段订单号 传入“代扣绑卡短信发送”接口的sms_order_id（一阶段二阶段用相同的订单号）
订单日期 order_date 定长8位String 必须 俗称二阶段订单日期 传入“代扣绑卡短信发送”接口的sms_order_date（一阶段二阶段用相同的订单日期） 格式：yyyyMMdd
短信验证码 sms_code 定长6位String 必须  
后台返回地址 bg_ret_url 变长128位的String 可选  
前台返回地址 ret_url 变长128位的String 可选  
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
返回码 resp_code 定长6位String 必须 返回码
返回描述 resp_desc 变长128位String 必须 返回描述
商户客户号 mer_cust_id 定长16位String 必须 商户客户号
用户客户号 user_cust_id 定长16位String 必须  
用户账户号 user_acct_id 变长9位String 必须  
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须 格式：yyyyMMdd
短信订单号 sms_order_id 变长50位String 必须  
短信订单日期 sms_order_date 定长8位String 必须 格式：yyyyMMdd
绑卡id bind_card_id 变长20位String 可选 此bind_card_id用于代扣解绑卡接口
签约流水 sign_seq_id 变长30位String 可选 此sign_seq_id用于代扣支付接口
商户私有域 mer_priv 变长120位的String 可选  
扩展域 extension 变长512位的String 可选 为商户的自定义字段，该字段在交易完成后由本平台原样返回

返回码

返回码 返回描述
公共返回码  
H10005 银行卡已存在，请勿重复操作
H10029 请重新发送短信
H10030 短信发送中
H10038 订单日期不一致

bind07 代扣订单录入

功能说明

适用产品企账通/app+，用于录入消费类订单信息（例如分期买手机时订单总金额），以便后续进行代扣。同一个产品订单可以被多个用户签约，相互独立、互不占用订单额度。可配合代扣绑卡短信发送接口使用，产品编号(product_id)需一致。

调用方式：后台返回（同步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
版本号 version 定长2位String 必须 目前固定为10
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
产品ID product_id 变长20位String 必须 由商户提供，产品的唯一标识，20位内数字或字母的组合
产品总金额 product_amt 变长14位String 必须 产品总金额，格式为###.00
产品期数 product_periods 变长14位String 必须 产品的期数
产品开始时间 product_start_time 定长14位String 必须 yyyyMMddHHmmss
产品结束时间 product_end_time 定长14位String 必须 yyyyMMddHHmmss
产品所在地 product_location 定长4位String 必须 产品的所在地：省份
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
应答返回码 resp_code 定长6位String 必须  
应答返回描述 resp_desc 变长String 必须 返回码的对应中文描述
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
产品ID product_id 变长20位String 必须 由商户提供，产品的唯一标识，20位内数字或字母的组合
产品总金额 product_amt 变长14位String 必须 产品总金额，格式为###.00
产品期数 product_periods 变长14位String 必须 产品的期数
产品开始时间 product_start_time 定长14位String 必须  
产品结束时间 product_end_time 定长14位String 必须  
产品所在地 product_location 定长4位String 必须 产品的所在地：省份
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  

返回码

返回码 返回描述
公共返回码  
H10051 无效的省份编号
H10048 项目信息重复
H10049 项目开始时间不能晚于或等于结束时间

pay007 协议代扣支付接口

功能说明

适用产品企账通/app+，该接口实现从用户银行卡代扣功能。

调用方式：后台返回（同步+异步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
版本号 version 定长2位String 必须 目前固定为10
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
用户客户号 user_cust_id 定长16位String 必须  
签约流水号 sign_seq_id 变长30位String 必须 代扣签约绑卡返回的签约流水
入账客户号 in_cust_id 定长16位String 必须  
入账账户号 in_acct_id 变长9位String 必须  
交易金额 trans_amt 变长14位String 必须 泛指交易金额，金额格式必须是###.00，比如2.00，2.01
手续费客户号 fee_cust_id 定长16位String 可选 用于指定手续费收取客户号
手续费账户号 fee_acct_id 变长9位String 可选 用于指定手续费收取账户号 传手续费客户号时必填，必须是属于手续费客户号下的账户号
商户后台应答地址 bg_ret_url 变长128位String 可选 通过后台异步通知，商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串，表明商户已经收到该笔交易结果。 注意： 1) URL中请不要包含特殊字符 2) 必须是外网地址
设备静态信息 dev_info_json 变长2000位String 必填 json格式如：{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”}；注：ipAddr和devType必填，MAC和IMEI 二选一必填，见下文
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  
付款方交易终端编码 payer_term_no 变长32位String 可选 请参考《网络支付报文结构及要素技术规范(V1.0)》(银办发[2016] 222号)
收款方交易终端类型 payee_term_type 定长2位String 可选 01-电脑 02-手机 03-平板设备 04-可穿戴设备 05-数字电视 06-条码支付受理终端 99-其他
收款方交易终端编码 payee_term_no 变长32位String 可选 请参考《网络支付报文结构及要素技术规范(V1.0)》(银办发[2016] 222号)
商品简称 goods_short_name 变长40位String 可选 不能包含特殊字符：<>&’”|%#\^-
订单超时时间 order_expire_time 定长14位String 可选 yyyyMMddHHmmSS 超时时长必须大于2小时， 小于2小时按2小时计算
交易发生地 transaction_addr 定长64位String 必填 例如：上海
用途 purpose 定长256位String 必填 例如：其他
对手方ip user_ip_addr 定长20位String 必填 用户终端ip

设备信息：

字段 字段描述 是否必须
devType 设备类型 1.电脑；2.手机 必填
ipAddr IP地址 必填
MAC MAC地址 选填
IMEI IMEI码 选填
devSysType 设备系统类型 1.IOS；2.安卓；3.windows 选填
UUID UUID 选填
IMSI IMSI码 选填
ICCID ICCID码 选填
MEID MEID码 选填
SEID SEID 选填
ipType IP地址类型代理、家庭、办公环境、网吧、学校等，直接给中文名称 选填
ipProvName IP省 选填
ipCityName IP市 选填
ipAreaName IP地区 选填
ipProvCode IP省编码 选填
ipCityCode IP市编码 选填
ipAreaCode IP地区编码 选填
cenX 定位（经度） 选填
cenY 定位（纬度） 选填
provName 定位地址（省） 选填
cityName 定位地址（市） 选填
areaName 定位地址（区） 选填
provCode 定位（省编码） 选填
cityCode 定位（市编码） 选填
areaCode 定位（区编码） 选填
unDevCode 用户交易设备（唯一识别码） 选填
serviceProviderIp 商户服务IP地址 选填
merUrl 商户网址 选填

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
应答返回码 resp_code 定长6位String 必须  
应答返回描述 resp_desc 变长String 必须 返回码的对应中文描述
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
用户客户号 user_cust_id 定长16位String 必须  
签约流水号 sign_seq_id 变长30位String 必须  
入账客户号 in_cust_id 定长16位String 必须  
入账账户号 in_acct_id 变长9位String 必须  
交易金额 trans_amt 变长14位String 必须 泛指交易金额，金额格式必须是###.00，比如2.00，2.01
手续费客户号 fee_cust_id 定长16位String 可选 用于指定手续费收取客户号
手续费账户号 fee_acct_id 变长9位String 可选 用于指定手续费收取账户号 传手续费客户号时必填，必须是属于手续费客户号下的账户号
手续费金额 fee_amt 变长14位String 可选  
本平台交易唯一标识号 platform_seq_id 变长20位String 可选  
商户后台应答地址 bg_ret_url 变长128位String 可选 通过后台异步通知，商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串，表明商户已经收到该笔交易结果。 注意： 1) URL中请不要包含特殊字符 2) 必须是外网地址
设备信息 dev_info_json 变长1024位String 可选  
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  

返回码

返回码 返回描述
公共返回码  
H10052 该用户代扣协议不存在或状态异常
H10053 签约卡信息不存在
H10054 签约卡信息异常
H10055 代扣支付仅支持借记卡

pay013 直接代扣支付

功能说明

适用产品企账通/app+，直接代扣。

调用方式：后台返回（同步+异步）

调用地址：

请求参数

参数中文名称 参数名称 数据格式 是否必须 说明
版本号 version 定长2位String 必须 目前固定为10
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
付款方姓名 user_name 定长50位String 必须  
付款方身份证号 cert_id 变长18位String 必须  
付款方银行预留手机号 card_mobile 定长11位String 必须  
付款方银行卡号 card_no 变长32位String 必须  
入账客户号 in_cust_id 定长16位String 必须  
入账账户号 in_acct_id 变长9位String 必须  
交易金额 trans_amt 变长14位String 必须 泛指交易金额，金额格式必须是###.00，比如2.00，2.01
手续费客户号 fee_cust_id 定长16位String 可选 用于指定手续费收取客户号
手续费账户号 fee_acct_id 变长9位String 可选 用于指定手续费收取账户号 传手续费客户号时必填，必须是属于手续费客户号下的账户号
商户后台应答地址 bg_ret_url 变长128位String 可选 通过后台异步通知，商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串，表明商户已经收到该笔交易结果。 注意： 1) URL中请不要包含特殊字符 2) 必须是外网地址
设备静态信息 dev_info_json 变长2000位String 必填 json格式如：{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”}；注：ipAddr和devType必填，MAC和IMEI 二选一必填，见下文
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  
付款方交易终端编码 payer_term_no 变长32位String 可选 请参考《网络支付报文结构及要素技术规范(V1.0)》(银办发[2016] 222号)
收款方交易终端类型 payee_term_type 定长2位String 可选 01-电脑 02-手机 03-平板设备 04-可穿戴设备 05-数字电视 06-条码支付受理终端 99-其他
收款方交易终端编码 payee_term_no 变长32位String 可选 请参考《网络支付报文结构及要素技术规范(V1.0)》(银办发[2016] 222号)
商品简称 goods_short_name 变长40位String 可选 不能包含特殊字符：<>&’”|%#\^- 默认：信息服务
订单超时时间 order_expire_time 定长14位String 可选 yyyyMMddHHmmSS 小于2小时以2小时算
交易发生地 transaction_addr 定长64位String 必填 例如：上海
用途 purpose 定长256位String 必填 例如：其他
对手方ip user_ip_addr 定长20位String 必填 用户终端ip

设备信息：

字段 字段描述 是否必须
devType 设备类型 1.电脑；2.手机 必填
ipAddr IP地址 必填
MAC MAC地址 选填
IMEI IMEI码 选填
devSysType 设备系统类型 1.IOS；2.安卓；3.windows 选填
UUID UUID 选填
IMSI IMSI码 选填
ICCID ICCID码 选填
MEID MEID码 选填
SEID SEID 选填
ipType IP地址类型代理、家庭、办公环境、网吧、学校等，直接给中文名称 选填
ipProvName IP省 选填
ipCityName IP市 选填
ipAreaName IP地区 选填
ipProvCode IP省编码 选填
ipCityCode IP市编码 选填
ipAreaCode IP地区编码 选填
cenX 定位（经度） 选填
cenY 定位（纬度） 选填
provName 定位地址（省） 选填
cityName 定位地址（市） 选填
areaName 定位地址（区） 选填
provCode 定位（省编码） 选填
cityCode 定位（市编码） 选填
areaCode 定位（区编码） 选填
unDevCode 用户交易设备（唯一识别码） 选填
serviceProviderIp 商户服务IP地址 选填
merUrl 商户网址 选填

返回参数

参数中文名称 参数名称 数据格式 是否必须 说明
应答返回码 resp_code 定长6位String 必须  
应答返回描述 resp_desc 变长String 必须 返回码的对应中文描述
商户客户号 mer_cust_id 定长16位String 必须 由汇付生成，商户的唯一性标识 出账方商户客户号
订单号 order_id 变长50位String 必须  
订单日期 order_date 定长8位String 必须  
入账客户号 in_cust_id 定长16位String 必须  
入账账户号 in_acct_id 变长9位String 必须  
交易金额 trans_amt 变长14位String 必须 泛指交易金额，金额格式必须是###.00，比如2.00，2.01
手续费客户号 fee_cust_id 定长16位String 可选 用于指定手续费收取客户号
手续费账户号 fee_acct_id 变长9位String 可选 用于指定手续费收取账户号 传手续费客户号时必填，必须是属于手续费客户号下的账户号
手续费金额 fee_amt 变长14位String 可选  
本平台交易唯一标识号 platform_seq_id 变长20位String 可选  
商户后台应答地址 bg_ret_url 变长128位String 可选 通过后台异步通知，商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串，表明商户已经收到该笔交易结果。 注意： 1) URL中请不要包含特殊字符 2) 必须是外网地址
设备信息 dev_info_json 变长1024位String 可选  
商户私有域 mer_priv 变长120位String 可选  
扩展域 extension 变长512位String 可选  

返回码

返回码 返回描述
公共返回码  
H10055 代扣支付仅支持借记卡
H10066 敏感信息脱敏失败