首信易支付子商户入网接口用于平台类商户为平台商品或服务的真实经营者进行开户注册。
https://apis.5upay.com/serviceprovider/declaration/declare
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| merchantId | 商户编号 | varchar(9) | 商户在首信易系统的唯一id，可在商户后台查看 | M |
| requestId | 请求号 | varchar(50) | 请求号为商户自行拟定，提交的请求号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单，商户平台不能以相同的请求号再次提交。 | M |
| operationType | 操作类型 | 固定值 | CREATE 创建 | M |
| MODIFY 更新 (当子商户入网的审核状态为NO_PASS时，根据审核备注信息，传此参数进行修改，requestId与创建时相同） |
||||
| notifyUrl | 通知地址 | varchar(200) | 服务器通知：当入网状态为终态后首信易服务器会向该地址发送通知，该地址可以带参数，如:http://www.5upay.com/callback.action?test=test。 | M |
| extendedParameters | 扩展参数 | 固定值 | sendExpressPayMsg是否发送API快捷支付短信验证 TRUE 是 FALSE 否 | M |
| sendActiveEmail是否发送激活邮件 TRUE 是 FALSE 否 | ||||
| 当两项参数都传递时用”,”隔开 示例：sendActiveEmail:TRUE,sendExpressPayMsg:FALSE | ||||
| baseInfo | 商户基本信息 | Json | 见下方商户基本信息表 | M |
| bankCardInfo | 结算信息 | Json | 见下方结算信息表 | M |
| desireAuthInfo | 开户意愿核实信息 | Json | 见开户意愿核实信息表，(开户意愿核实类型选择手机短信验证时此项必传) | C |
| certificateInfo | 商户资质信息 | Json | 见商户资质信息表 | M |
| certificateContacts | 最终受益人信息 | Json数组 | 见最终受益人信息表(收单子商户且商户类型不为自然人或个体工商户时必传) | C |
| contractInfo | 商户合同信息 | Json | 见商户合同信息表 | M |
| paymentProfiles | 产品支付方式 | Json数组 | 见产品支付方式表（商户入网类型为收单子商户时必传） | C |
| settlementProfile | 商户结算配置信息 | Json | 见商户结算配置信息表（清算方式选择结算时必传） | C |
| hmac | 参数签名 | varchar(500) | 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 | M |
本接口资质信息上传需要配合ftp使用
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| signedType | 商户入网类型 | 固定值 | BY_SPLIT_BILL 被分账方 | M |
| GENERAL_SUB_MERCHANT 收单子商户 | ||||
| signedName | 签约名称 | varchar(80) | 签约名称(当商户签约性质为自然人时，签约名称为自然人姓名) | M |
| registerRole | 商户签约性质 | 固定值 | INDIVIDUAL_BUSINESS 个体工商户 | M |
| PUBLIC_INSTITUTIONS 事业单位 | ||||
| PRIVATE_NON_ENTERPRISE_ORGANIZATIONS 民办非企业组织 | ||||
| SOCIAL_ORGANIZATION 社会团体 | ||||
| UNINCORPORATED_ENTERPRISE 非法人企业 | ||||
| ENTERPRISE_LEGAL_PERSON 企业法人 | ||||
| NATURAL_PERSON自然人 | ||||
| GOVERNMENT_AGENCIES 政府机关 | ||||
| OTHERS 其他 | ||||
| cerType | 证书类型 | 固定值 | UNIFORM_SOCIAL_CREDIT_CODE 统一社会信用代码证 | C |
| PRIVATE_NON_ENTERPRISE_UNIT_REGISTRATION_CERTIFICATE 民办非企业单位登记证书 | ||||
| INDIVIDUAL_BUSINESS_LICENCE 个体工商户营业执照 | ||||
| CERTIFICATE_OF_REGISTRATION_OF_SOCIAL_GROUP_LEGAL_PERSON 社会团体法人登记证书 | ||||
| LEGAL_PERSON_CERTIFICATE_OF_INSTITUTION 事业单位法人证书 | ||||
| FUND_LEGAL_PERSON_REGISTRATION_CERTIFICATE 基金法人登记证书 | ||||
| ID_CARD 身份证 | ||||
| BUSINESS_LICENSE 营业执照 | ||||
| OTHERS 其他 | ||||
| 当签约性质不为自然人时必传 | ||||
| signedShorthand | 商户简称 | varchar(80) | 商户简称 | M |
| businessAddressProvince | 经营地址省 | varchar(6) | 见编码表，当商户签约性质为自然人时，传入自然人身份证住址信息 | M |
| businessAddressCity | 经营地址市 | varchar(6) | 见编码表，当商户签约性质为自然人时，传入自然人身份证住址信息 | M |
| businessAddressArea | 经营地址区 | varchar(6) | 见编码表，当商户签约性质为自然人时，传入自然人身份证住址信息。如果选择的省市只有两级没有下一级时可不传此字段，如：东莞市、中山市、三沙市、儋州市，除此四个市之外的其他市均需要传此字段 | C |
| businessAddress | 经营地址 | varchar(200) | 商户详细经营地址，当商户签约性质为自然人时，传入自然人身份证住址信息 | M |
| contactName | 联系人姓名 | varchar(50) | 联系人姓名 | M |
| contactEmail | 联系人邮箱 | varchar(100) | 联系人邮箱 | M |
| contactPhone | 联系人电话 | varchar(11) | 联系人电话 | M |
| businessClassification | 业务分类 | 固定值 | 见编码表，此项分为一级和二级，传递此参数时需要用下划线拼接一级和二级业务分类，例如：一级为：INTERNAL_TESTING，二级为：01，
传递参数则是：INTERNAL_TESTING_01 (商户入网类型为收单子商户时必传，被分账方默认取父商户) |
C |
| desireAuth | 开户意愿核实类型 | 固定值 | DESIRE_VIDEO 视频验证 | C |
| DESIRE_MOBILEINFO手机短信验证(选择短信验证如果未收到验证码可以调用重发验证短信接口进行重新获取) | ||||
| DESIRE_NONEED 其他验证方式 | ||||
| 商户入网类型为收单子商户时必传 | ||||
| belongAgentNumber | 所属代理商编 | varchar(9) | 所属代理商的商户编号 | O |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| bankName | 开户行名称 | varchar(50) | 开户行名称（结算银行卡属性为对公时必填） | C |
| bankBranchName | 支行名称 | varchar(80) | 支行名称（结算银行卡属性为对公时必填） | C |
| accountName | 开户名称 | varchar(80) | 开户名称 | M |
| bankCardNo | 开户账号 | varchar(80) | 开户账号(中国农业银行对公账户需在账户前添加两位省市编码，可咨询开户银行获取此编码) | M |
| cityCode | 市编码 | varchar(6) | 见结算省市编码表 | M |
| provinceCode | 省编码 | varchar(6) | 见结算省市编码表 | M |
| accountType | 结算银行卡属性 | 固定值 | PUBLIC 对公 | C |
| PRIVATE 对私 | ||||
| （商户签约性质为个体工商户时必填，个人默认对私，企业等默认对公） | ||||
| liquidationType | 清算方式 | 固定值 | SETTLE 结算 | C |
| WITHDRAW 提现 | ||||
| 不传默认结算 | ||||
| withdrawRateType | 提现费率类型 | 固定值 | SINGLE 单笔 | C |
| RATE 百分比 | ||||
| 清算方式选择提现时必传 | ||||
| withdrawRate | 提现费率 | varchar(20) | 若计费种类为百分比时，可以支持填写到小数点后四位，配置此项时校验服务商提现费率，如果服务商是百分比费率配置则此项也必须配置百分比，固定值同样，且此项配置费率不能小于服务商费率（清算方式选择提现时必传） | C |
| reserveDays | 风险预存期 | varchar(3) | 仅可填写非负整数，不可小于服务商配置的最小风险预存期，当商户入网类型为收单子商户时生效(不传默认为 1) | C |
| reservedPhoneNo | 银行预留手机号 | varchar(11) | 银行预留手机号是对私结算卡在银行开户时预留的手机号 | C |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| legalPersonName | 法人姓名 | varchar(50) | 法人姓名 | C |
| legalPersonIdNo | 法人身份证号 | varchar(20) | 法人身份证号 | C |
| legalPersonPhoneNo | 意愿核实法人手机号 | varchar(11) | 法人手机号，若使用电子签约，则意愿核实法人手机号需要与电子签约法人手机号一致 | C |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| legalPersonName | 法人姓名 | varchar(50) | 法人姓名 | M |
| profession | 法人职业 | varchar(10) | 见编码表（商户类型为自然人时必传） | C |
| legalPersonPhone | 电子签约法人手机号 | varchar(11) | 合同类型为电子签时必填，必须为法人的手机号或结算卡银行预留手机号。当银行预留手机号有值时，电子签约法人手机号必须使用银行预留手机号 | C |
| legalPersonIdType | 法人证件类型 | 固定值 | IDCARD 身份证 | M |
| PASSPORT 护照 | ||||
| OFFICERPASS 军官证 | ||||
| ARMEDPOLICE 武警证 | ||||
| HM_VISITORPASS 港澳居民往来内地通行证 | ||||
| RESIDENCEBOOKLET 户口簿 | ||||
| T_VISITORPASS 台湾居民来往大陆通行证 | ||||
| FOREIGNESTAYFOREVER 外国人永久居留证 | ||||
| OTHER 其它证件号 | ||||
| legalPersonIdNo | 证件号码 | varchar(20) | 证件号码 | M |
| idEffectiveDateStart | 法人证件有效期开始日期 | varchar(10) | 格式：yyyy-MM-dd，例：2020-08-03 | M |
| idEffectiveDateEnd | 法人证件有效期结束日期 | varchar(10) | 格式：yyyy-MM-dd，例：2030-08-03。若为长期可传 2099-12-31 | M |
| cerNo | 资质证书编号 | varchar(20) | 资质证书编号 （商户类型不为自然人时必传） | C |
| sellingArea | 营业面积 | 固定值 | A:500平米以上 | C |
| B:200-500平米（含） | ||||
| C:200平米以下 | ||||
| 商户类型不为自然人时必传 | ||||
| staffSize | 公司员工规模 | 固定值 | A:100人以上 | C |
| B:50-100人（含） | ||||
| C:50人以下 | ||||
| 商户类型不为自然人时必传 | ||||
| tradingScenarios | 交易场景说明 | 固定值 | WEBSITE 网站 | C |
| APP APP | ||||
| WECHAT_APPLET 公众号/小程序/生活号 | ||||
| 可多选，多选时参数用英文半角逗号隔开，商户类型不为自然人或被分账方时必传 | ||||
| webSite | 网站网址 | varchar(200) | 网站网址 （商户类型不为自然人或被分账方时，如交易场景基于PC网站时必传） | C |
| webSiteName | 网站名称 | varchar(80) | 网站名称 （商户类型不为自然人或被分账方时，如交易场景基于PC网站时必传） | C |
| icp | ICP备案号 | varchar(40) | ICP备案号 （商户类型不为自然人或被分账方时，如交易场景基于PC网站时必传） | C |
| appName | App名称 | varchar(80) | App名称 （商户类型不为自然人或被分账方时，如交易场景基于APP时必传） | C |
| wechatAppletName | 公众号/小程序/生活号 | varchar(80) | 公众号/小程序/生活号 （商户类型不为自然人或被分账方时，如交易场景基于公众号/小程序/生活号时必传） | C |
| testAccountInfo | 测试账户信息 | varchar(200) | 填写可用于首信易审核人员测试交易全流程的测试账号密码 | O |
| businessLicensePath | 营业执照照片路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型不为自然人时必传，最大不超过1M，格式限制为jpg,png,bmp） | C |
| openAccountPath | 开户许可证照片路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型不为自然人及个体工商户时必传，为个体工商户时此项和legalPersonBankCardPath二选一进行传递，最大不超过1M，格式限制为jpg,png,bmp） | C |
| legalIdCardProsPath | 法人证件人像面路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（最大不超过1M，格式限制为jpg,png,bmp） | M |
| legalIdCardConsPath | 法人证件国徽面路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（最大不超过1M，格式限制为jpg,png,bmp） | M |
| desireAuthPath | 确认入网意愿视频路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（认证类型选择视频认证时必填，最大不超过5M，格式限制为avi、wmv、mpeg、mp4、mov、mkv、flv、f4v、m4v、rmvb） | C |
| holdingIdCardPath | 法人手持证件影印件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（认证类型选择手机验证时必传，最大不超过1M，格式限制为jpg,png,bmp） | C |
| webSitePath | 商户网址截图影印件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型不为自然人或被分账方时，如交易场景基于PC网站时必传，最大不超过1M，jpg,png,bmp） | C |
| wechatAppletPath | 公众号/小程序/生活号业务流程截图影印件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型不为自然人或被分账方时，如交易场景基于公众号/小程序/生活号时必传，最大不超过2M，jpg,png,bmp） | C |
| appPath | APP首页截图影印件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型不为自然人或被分账方时，如交易场景基于APP时必传，最大不超过1M，格式限制为jpg,png,bmp） | C |
| legalPersonBankCardPath | 法人银行卡图影印件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（商户类型为自然人时必传，为个体工商户时，结算银行卡属性为对私，此项必填。结算银行卡属性为对公，此项和openAccountPath二选一进行传递，最大不超过1M，格式限制为jpg,png,bmp） | C |
| desireAuthOtherPath | 确认入网意愿其他验证方式路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（开户意愿核实类型选择“其他验证方式”的时候必传最大不超过2M，格式限制为jpg,png,bmp） | |
| otherCerPath | 其他资质文件路径 | varchar(200) | 需上传到sftp,见开发者服务-sftp数据传输说明（最大不超过5M，格式限制为AVI、mov、rmvb、rm、FLV、mp4、3GP、jpg、jpeg、png、pdf、ZIP、RAR） | C |
| storeHeaderPath | 门店门头照片路径 | varchar(200) | 商户类型为“收单子商户”时，该参数必传，需上传到sftp,需与“店内场景照片路径”同时传值或同时不传值。 填写规范： 门店场所：提交门店门口照片，要求招牌清晰可见 流动经营/便民服务：提交经营/服务现场照片线上商品/服务交易：提交店铺首页截图。（最大不超过2M，格式限制为jpg,png,bmp） | C |
| storeIndoorPath | 店内场景照片路径 | varchar(200) | 商户类型为“收单子商户”时，该参数必传，上传到sftp,需与“店内场景照片路径”同时传值或同时不传值。 填写规范： 门店场所：提交门店门口照片，要求招牌清晰可见 流动经营/便民服务：提交经营/服务现场照片线上商品/服务交易：提交店铺首页截图。（最大不超过2M，格式限制为jpg,png,bmp） | C |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| name | 最终受益人姓名 | varchar(50) | 最终受益人姓名 | C |
| idType | 最终受益人证件类型 | 固定值 | IDCARD 身份证 | C |
| PASSPORT 护照 | ||||
| OFFICERPASS 军官证 | ||||
| ARMEDPOLICE 武警证 | ||||
| HM_VISITORPASS 港澳居民往来内地通行证 | ||||
| RESIDENCEBOOKLET 户口簿 | ||||
| T_VISITORPASS 台湾居民来往大陆通行证 | ||||
| FOREIGNESTAYFOREVER 外国人永久居留证 | ||||
| OTHER 其它证件号 | ||||
| idNo | 最终受益人证件号码 | varchar(20) | 最终受益人证件号码 | C |
| effectiveDateStart | 最终受益人证件有效期开始日期 | varchar(10) | 格式：yyyy-MM-dd，例：2020-8-3 | C |
| effectiveDateEnd | 最终受益人证件有效期结束日期 | varchar(10) | 格式：yyyy-MM-dd，例：2030-8-3。若为长期可传 2099-12-31 | C |
| address | 最终受益人住址 | varchar(200) | 最终受益人住址 | C |
| equityRatio | 股权占比 | varchar(10) | 股权占比（%） （只允许数字和小数点后两位） | C |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| receiverName | 收件人 | varchar(50) | 收件人 | C |
| receiverPhone | 收件人电话 | varchar(20) | 收件人电话 | C |
| receiverAddress | 收件人地址 | varchar(200) | 收件人地址 | C |
| contractType | 合同类型 | 固定值 | ELECTRON 电子签 | C |
| PAPER 纸质合同 | ||||
| CUSTOM 自定义签约 | ||||
| 默认为“纸质合同”，选择“电子签”时将授权首信易通过电子签名的方式进行签约，无需邮寄合同。 商户入网类型为被分账方时必传电子签或自定义签约，自定义签约需要提前与我司约定好协议内容才可以使用。 |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| paymentMode | 支付方式 | 固定值 | B2C 个人网银 | C |
| B2B 企业网银 | ||||
| EXPRESS_PAY_ISNOTDIRECT_DEBIT 快捷支付标准版借记卡 | ||||
| EXPRESS_PAY_ISNOTDIRECT_CREDIT 快捷支付标准版贷记卡 | ||||
| EXPRESS_PAY_ISDIRECT_DEBIT 快捷支付专业版借记卡 | ||||
| EXPRESS_PAY_ISDIRECT_CREDIT 快捷支付专业版_贷记卡 | ||||
| WEIXIN_OFFICIAL 微信公众号 | ||||
| WEIXIN_MINIAPPS 微信小程序 | ||||
| ALIPAY_WAP 支付宝wap | ||||
| ALIPAY_SCANCODE 支付宝扫码 | ||||
| ALIPAY_OFFICIAL 支付宝生活号 | ||||
| WEIXIN_EQRCODE 易码付-微信 | ||||
| ALIPAY_EQRCODE 易码付-支付宝 | ||||
| WEBOX_EQRCODE_DEBIT 易码付-微包-借记卡 | ||||
| WEBOX_EQRCODE_CREDIT 易码付-微包-贷记卡 | ||||
| WEBOX_EQRCODE_BALANCE 易码付-微包-余额 | ||||
| UNION_EQRCODE 易码付-云闪付 | ||||
| WEBOX_APP_DEBIT 微包APP-借记卡 | ||||
| WEBOX_APP_CREDIT 微包APP-贷记卡 | ||||
| WEBOX_APP_BALANCE 微包APP-余额 | ||||
| WEBOX_SVC_DEBIT 微包服务号-借记卡 | ||||
| WEBOX_SVC_CREDIT 微包服务号-贷记卡 | ||||
| WEBOX_SVC_BALANCE 微包服务号-余额 | ||||
| UNION_SCANCODE_PAY 银联扫码支付 | ||||
| APP_UNION 云闪付收银台支付 | ||||
| MINIAPPS_ALI_PAY 支付宝小程序支付 | ||||
| UNION_WAP 银联WAP支付 | ||||
| 商户入网类型为收单子商户时可传 | ||||
| feeType | 费率类型 | 固定值 | SINGLE 单笔 | C |
| RATE 百分比 | ||||
| 商户入网类型为收单子商户时可传(需与服务商类型保持一致) | ||||
| feeAmount | 费率 | varchar(10) | 商户入网类型为收单子商户时，费率可传自定义费率，若计费种类为百分比时，可以支持填写到小数点后四位（一般需大于服务商费率）如不传则按服务商默认费率 | C |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| settleMode | 结算方式 | 固定值 | REGULAR_SETTLE：定期结算 | C |
| SETTLE：自助结算 | ||||
| 收单商户必填；被分账商户选填，不传默认定期结算 | ||||
| minAmount | 最低结算金额 | varchar(10) | 商户入网类型为收单子商户时默认500，为被分账方时默认0 | C |
| cycleType | 定期结算类型 | 固定值 | BYMONTH月结 | C |
| BYWEEK周结 | ||||
| 结算方式为定期结算时可传，如不传默认周结 | ||||
| cycleData | 结算日期 | 固定值 | 周结可传1-7的数字 | C |
| 月结1-28的数字 | ||||
| 如不传默认为1,2,3,4,5,6,7 |
以上参数值中不能包含以下特殊字符’”&<>()
| 参数名称 | 参数中文名称 | 参数说明 |
|---|---|---|
| merchantId | 商户编号 | 同请求参数 |
| requestId | 订单号 | 同请求参数 |
| subMerchantId | 子商户编号 | 由首信易返回的子商户编号 |
| status | 响应状态 | SUCCESS 成功 FAILED 失败 ERROR 错误(此状态的返回参数见异常情况说明) |
| errorMessage | 错误信息 | 错误信息 |
| hmac | 参数签名 | 首信易生成的参数签名结果，验签过程请参考解密流程 |
| 参数名称 | 参数中文名称 | 参数说明 |
|---|---|---|
| merchantId | 商户编号 | 同请求参数 |
| requestId | 订单号 | 同请求参数 |
| subMerchantReviewStatus | 子商户审核状态 | PROCESSING 审核中(ocr校验失败时返回该状态，子商户审核备注信息中可查看详情) PASS 审核通过 NO_PASS 审核不通过 REFUSE 审核拒绝 ESIGN_PROCESS 待签约 ESIGN_PROCESSING 签约中 ESIGN_FAIL 签约失败(电子签签约状态） ESIGN_SUCCESS 签约成功(电子签签约状态） SUCCESS 入网完成 |
| subMerchantReviewRemarks | 子商户审核备注 | 审核备注 |
| subMerchantId | 子商户商编 | 子商户商编 |
| electronicContractingUrl | 电子签约链接 | 若签约方式为电子签约(自定义签约)，则在子商户审核状态为“ESIGN_PROCESSING 签约中”时返回电子签约地址。 |
| postReviewStatus | 核查状态 | INIT 初始化 SUCCESS 核查通过 FAIL 核查不通过 COMPLEMENT 核查补充 返回“核查补充”状态时，可通过“核查补充”接口或核查补充链接提交补充的材料，当触发入网后核查时, 会返回“核查状态”，核查不通过将影响交易 |
| certificateSupplementUrl | 核查补充链接 | 当异步返回参数中postReviewStatus“核查状态”为COMPLEMENT“核查补充”时，返回核查补充链接，入网商户可以通过该链接对需要补充的资质进行上传 |
| postReviewRemark | 核查备注 | 核查状态为“核查不通过“或“核查补充”时，返回该字段 |
| hmac | 参数签名 | 首信易生成的参数签名结果，验签过程请参考解密流程 |