商户调用此接口,服务端同步返回受理状态。商户接收慧收钱“入网通知接口”得到进件结果,或者主动调用查询“商户进件查询接口”获取商户进件结果。
个体工商户进件签需要调用资质文件上传接口上传相关资质文件。
慧收钱代理商需要将商户信息通过API方式上送到慧收钱,慧收钱审核后会依据商户协议开通相应产品。
接口说明
测试请求URL:https://test-api.huishouqian.com/merchant/register
生产请求URL:https://api.huishouqian.com/merchant/register
请求方式:POST
公共请求参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
method | 方法名 | string[1,32] | 是 | AGENT_REGISTER_INDIVIDUAL-个体工商户进件 |
version | 版本 | string[1,16] | 是 | 接口版本:2.0.0 |
format | 请求格式 | string[1,16] | 是 | 业务请求参数格式,支持:JSON、XML |
agentMerchantNo | 代理商商户号 | string[1,16] | 是 | 商户在慧收钱的代理商商户号,由慧收钱生成并下发 |
signType | 加密类型 | string[1,16] | 是 | RSA2:签名机制查看说明 |
signContent | 加密数据 | string | 是 | 业务请求参数 |
sign | 签名数据 | string[1,128] | 否 | 签名数据 |
业务请求参数
量变 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
基本信息 | ||||
transNo | 进件请求流水号 | string[1,32] | M | 商户请求进件唯一流水号,每次请求不可重复 |
merchantName | 商户全称 | string[1,32] | M | 营业执照上的商户名称 |
merchantShortName | 商户简称 | string[1,16] | M | 在支付完成页展示给消费者 |
servicePhone | 客服电话 | string[1,16] | M | 客服电话 |
联系邮箱 | string[1,32] | M | 用于登录的账号或者接收邮件的邮箱 | |
industryType | 经营类目 | string[1,16] | M | 详见附录经营类目 |
business | 行业 | string[1,16] | M | 详见附录行业 |
businessCope | 企业经营范围 | string[1,128] | O | 与营业执照上一致 |
merchantIdType | 企业/个体证件类型 | string[1,32] | O | 默认NATIONAL_LEGAL,NATIONAL_LEGAL:营业执照;NATIONAL_LEGAL_MERGE:营业执照(多证合一);INST_RGST_CTF:事业单位法人证书 |
businessLicense | 企业/个体证件编号 | string[1,32] | M | 企业/个体证件编号 |
registeredAddress | 企业注册地址 | string[1,128] | M | 与营业执照上一致 |
establishDate | 企业成立日期 | string[1,14] | M | 与营业执照上一致 |
licenseOverdueTime | 企业证件到期日 | string[1,14] | M | 营业期限结束日期 |
companyScene | 业务场景 | string[1,32] | M | [存在多个时,用逗号(,)隔开。详见附录:业务场景 |
publicKey | 商户公钥 | string[1,2048] | O | 具备开发能力代理商将其商户自有公钥(cer)文件里面的内容以字符串形式进行传输至慧收钱,慧收钱生成对应公钥,商户需要存储该信息用于其支付交易。 说明:加解密可参考[加密机制] |
returnUrl | 通知地址 | string[1,64] | O | 上送后则慧收钱通过该地址主动通知结果 https://xxx.com/notify |
superMerchantNo | 主商户号 | string[1,64] | C | 慧收钱生成的商户编号,商户开通结算门店时必填 |
notifyflag | 是否发开户信息 | string[1,64] | O | 是否由慧收钱发开户短信、邮件给商户 默认1,1.发送;2.不发送 |
地址信息 | ||||
districtCode | 地区编码 | string[1,16] | M | 商户所在地区编码。详见附录省市编码 |
address | 地址 | string[1,128] | M | 商户所在地址 |
longitude | 经度 | string[1,16] | O | 商户所在地址的经度 |
latitude | 纬度 | string[1,16] | O | 商户所在地址的纬度 |
法人信息 | ||||
legalName | 法人姓名 | string[1,32] | M | 法定代表人姓名 |
legalIdcardNo | 法人证件号码 | string[1,32] | M | 证件号码 |
legalIdcardType | 法人证件类型 | string[1,16] | O | 默认身份证。详见附录证件类型 |
legalCertStartDate | 法人证件开始时间 | string[1,16] | M | 证件有效期的开始时间 |
legalCertEndDate | 法人证件过期时间 | string[1,16] | M | 证件有效期的结束时间 |
legalPhone | 法人手机号码 | string[1,14] | O | 联系人为法人时,手机号码为必填 |
nationality | 国籍 | string[1,14] | M | 法人国籍 |
联系人信息 | ||||
contactName | 联系人姓名 | string[1,32] | M | 联系人类型为法人时,与法人信息一致 |
contactPhone | 联系人手机号 | string[1,16] | M | 联系人类型为法人时,与法人信息一致,用于接收签约协议的短信验证码 |
contactIdcardType | 联系人证件类型 | string[1,16] | O | 默认身份证。详见附录证件类型 |
contactCertEndDate | 联系人证件过期时间 | string[1,14] | M | 联系人类型为法人时,与法人信息一致 |
contactIdcardNo | 联系人证件号 | string[1,32] | M | 联系人类型为法人时,与法人信息一致 |
contactType | 联系人类型 | string[1,32] | C | 默认LEGAL_PERSON,LEGAL_PERSON:法人;CONTROLLER:实际控制人;AGENT:代理人;OTHER:其他 示例值:LEGAL_PERSON |
contactLogonId | 支付宝账号 | string[1,32] | C | 支付宝账号,开通支付宝支付时必填 |
contactWeChatId | 微信账号 | string[1,32] | C | 微信账号,开通微信支付时必填 |
联系人QQ | string[1,16] | O | 联系人QQ | |
结算信息 | ||||
bankCardNo | 银行卡号 | string[1,32] | M | 银行卡号码 |
cnapsNo | 联行号 | string[1,16] | M | 开户银行联行号。详见附录联行号 |
cardNameType | 银行卡户名类型 | string[1,32] | O | 1:企业名称(商户全称);2:法人姓名; 说明:该值暂时只能支持个体工商户 |
settlePeriod | 结算类型 | string[1,2] | O | 请联系技术支持 |
影像资料 | ||||
idCardFrontImg | 法人身份证正面 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
idCardBackImg | 法人身份证反面 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
idCardHandImg | 法人手持身份证照 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
storeImg | 门头照 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
placeImg | 营业场所照片 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
businessLicenseImg | 企业证件照 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
bankLicenseImg | 开户许可证 | string[1,32] | M | 对应资质文件上传接口返回的fileId |
protocolImg | 平台协议 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
socialCreditCodeImgUrl | 统一社会信用代码 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
icNetScreenShotUrl | 工商网截图 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
icpImg | icp备案照片 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
orgCodeImg | 组织机构代码证照片 | string[1,32] | O | 对应资质文件上传接口返回的fileId |
otherImgs | 其它图片 | string[1,128] | O | 最多支持六张,多个逗号(,)隔开。对应资质文件上传接口返回的fileId |
预留信息 | ||||
extend1 | 扩展字段 | string[1,128] | O | |
产品信息 | ||||
productType | 产品属性 | string[1,2] | M | 1:不分账;2:收单分账;3:账户分账;4:组合支付 实例值:1 |
payConfigList | 开通产品列表 | array | M | 开通产品列表(payConfigList)JSON集合 |
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
powerId | string[1,32] | 产品编码 | M | 支付产品 |
rate | string[1,32] | 费率 | M | 单位:例5=0.5% 当产品是UNION_DEBIT_MAX_FEE时,单位为元,例50=50.00元 |
extend1 | string[1,32] | 扩展字段1 | O | |
公共请求示例
{method=AGENT_REGISTER_PERSON, format=json, signType=CFCA, signContent=7ecbad9cb113bd54e6ee45f7fe76883a40428d548b7294ce8f7ba30f211881073820d3ec7a54d3406dcf7a4d3f87f0994c24db54bab430777425147378dbf01afe0491a1c287e5ce380454b0e228a5a20d541874c14addd4100199660e6c4a857fa080ceb4601a0ee21e3fab9d87016198f151a3b16f60a254c1e8b4cd42cdf7, version=1.0, merchantNo=8000000026}
业务请求示例
公共响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
success | 响应状态 | string[1,32] | 是 | 服务端响应状态,如果为true,则可以调用result;如果为false,则调用errorCode来获取出错信息 |
errorCode | 错误码 | string[1,32] | 否 | 响应码 |
errorMsg | 错误描述 | string[1,128] | 否 | 响应描述 |
result | 响应内容 | string | 否 | 业务响应参数 |
sign | 签名数据 | string[1,128] | 否 | 响应验签数据 |
业务响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
transNo | 进件请求流水号 | string[1,32] | R | 商户请求进件唯一流水号,每次请求不可重复 |
applyNo | 进件申请编号 | string[1,16] | M | 慧收钱生成进件申请编号 |
status | 状态 | string[1,16] | M | 状态码 |
respCode | 应答码 | string[1,32] | C | 交易响应码 |
respMsg | 应答信息 | string[1,16] | C | 应答描述 |
公共响应示例
{
"success":true,
"result":"88faca1f2511cc194367ffd96aa78a4cdf25a8284b0cd74b75e331b37c642b26aaeb46f2e4be38080eeb2b78575abd715d58fd30bbf59e167d64d0b714487f9462381e499a48524b1704694f256fa8f6e917d33cd413e365872ef2c7eede37ab4b23f67dcf6f34ec0daf65a34502123f792a646bea6447c126a612087825b17b91e585f74e56220328b198982e62a734387cd8556927e6881878b821969b6e784a20771cf55fad70a4368b8650c0ece0a7903678e1ad6134f6c711329a3e3e456c28ffbfc607fa6bf1f969a4d38b35ca3bf9ad81f71b2d2ad816502d579c0c4fc1f1fccec74a861c4679c5217be0176bf1eebcb57aea381f922fcf920aa471198be972f0c4f9fab10f7885b9c09eda977351b40e9058247ec30da55dd4c0be4a9de7d996e186e9f9ff2693f564f0eaddca9d7ff9f3b813d0c70bdba75b2a1bf9bd4ddf28ff66c45d6ce31e188d8606c82078d842008a9a1b4c1b64b7b2d3632087e46bbc4322181a9832cecd852682fdb72d336b32512bde94e81ba322fe9d2d",
"errorCode":null,
"errorMsg":null,
"sign":null
}
业务响应示例
交易状态码
交易状态码 | 描述 |
---|---|
INIT | 初始化 |
PROCESSING | 处理中 |
SUCCESS | 成功 |
FAIL | 失败 |
交易响应码
响应码 | 描述 |
---|---|
110000 | 受理成功 |
110001 | 系统异常,请稍后再试 |
110002 | 代理商不存在 |
110003 | 外部商户号重复 |
110004 | 接口权限不足 |
110005 | 参数错误,校验不通过 |
110006 | 商户号信息不存在 |
110007 | 暂未开通任何支付功能 |
110008 | 文件类型不合法 |
110009 | 文件大小超限 |
110010 | 开户许可图片不存在 |
110011 | 营业执照图片不存在 |
110012 | 身份证正面图片不存在 |
110013 | 身份证反面图片不存在 |
110014 | 门头照图片不存在 |
110015 | 手持身份证正面图片不存在 |
110016 | 工商网截图图片不存在 |
110017 | IPC备案图图片不存在 |
110018 | 组织机构代码图片不存在 |
110019 | 统一信用代码图片不存在 |
110020 | 营业场所图片不存在 |
110021 | 其它图片不存在 |
110022 | 暂不支持此支付功能在线开通 |
110023 | 商户审核中,暂不支持开通支付功能 |
110024 | 支付功能已开通,请勿重复开通 |
支付产品
参数名 | 参数描述 | 备注 |
---|---|---|
ALIPAY | 支付宝 | 开通支付宝产品 |
微信 | 开通微信产品 | |
UNION_DEBIT_PETTY | 银联-借(1000以下) | 若开通银联-借产品,必填 |
UNION_DEBIT_LARGE | 银联-借(1000以上) | 若开通银联-借产品,必填 |
UNION_DEBIT_MAX_FEE | 银联-借(封顶金额) | 若开通银联-借产品,必填 |
UNION_CREDIT_PETTY | 银联-贷(1000以下) | 若开通银联-贷产品,必填 |
UNION_CREDIT_LARGE | 银联-贷(1000以上) | 若开通银联-贷产品,必填 |
证件类型
证件类型 | 描述 |
---|---|
1 | 大陆身份证 |
2 | 护照 |
3 | 港澳居民来往内地通行证 |
4 | 台湾居民来往内地通行证 |
5 | 其它 |
职业
职业 | 描述 |
---|---|
1A | 各类专业,技术人员 |
1B | 国家机关,党群组织,企事业单位的负责人 |
1C | 办事人员和有关人员 |
1D | 商业工作人员 |
1E | 服务性工作人员 |
1F | 农林牧渔劳动者 |
1G | 生产工作,运输工作和部分体力劳动者 |
1H | 不便分类的其他劳动者 |
业务场景
业务场景 | 描述 |
---|---|
扫码 | 扫码 |
公众号 | 公众号 |
小程序 | 小程序 |
app | app |
互联网网站 | 互联网网站 |
其他 | 其他 |
作者:xiaochen 创建时间:2023-05-24 15:12
最后编辑:xiaochen 更新时间:2025-01-09 17:41
最后编辑:xiaochen 更新时间:2025-01-09 17:41