API开户
| 请求方式 | body | 编码 | 接口地址 |
|---|---|---|---|
| POST | application/json | UTF-8 | 集测:https://mchapitest.shengpay.com/merchant/api/register 生产:https://mchapi.shengpay.com/merchant/api/register |
请求参数
| 变量名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| mchId | String(12) | Y | 30057909 | 平台或者服务商户号 |
| businessCode | String(32) | Y | 10000101 | 接入方服务商户号+申请编号 唯一 |
| subjectType | String(16) | Y | INDIVIDUAL | 企业:ENTERPRISE 个体工商户:INDIVIDUAL 小微商户:PERSONAL 政府机关:GOVERNMENT 事业单位:INSTITUTIONS 社会组织:SOCIAL |
| applyType | String(16) | Y | LEGAL | 固定值:LEGAL |
| loginAccount | String(32) | Y | 13813813811 | 手机号或者邮箱 |
| mcc | String(16) | Y | 5812 | 行业类目 |
| remark | String(64) | Y | 备注信息 | |
| contactInfo | String | Y | ||
| contactName | String(16) | Y | 张三 | 联系人姓名 |
| contactPhone | String(32) | Y | 13813813811 | 联系人电话 |
| contactEmail | String(32) | Y | 163@QQ.COM | 联系人邮箱 |
| contactIdDocNumber | String(32) | N | 联系人身份证号,用于提交微信开户意愿申请,如联系人为非法人时,需要传入;如联系人为法人时,不需要传入 | |
| contactIdDocCopy | String(64) | N | 联系人证正面照,用于提交微信开户意愿申请,如联系人为非法人时,需要传入;如联系人为法人时,不需要传入,图片上传请参考 图片上传 | |
| contactIdDocNational | String(64) | N | 联系人身份证反面照,用于提交微信开户意愿申请,如联系人为非法人时,需要传入;如联系人为法人时,不需要传入,图片上传请参考 图片上传 | |
| contactIdPeriodBegin | String(16) | N | 联系人身份证起始有效期,用于提交微信开户意愿申请,如联系人为非法人时,需要传入;如联系人为法人时,不需要传入,格式为YYYY-MM-DD | |
| contactIdPeriodEnd | String(16) | N | 联系人身份证结束有效期,用于提交微信开户意愿申请,如联系人为非法人时,需要传入;如联系人为法人时,不需要传入,格式YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| identityInfo | String | Y | 法人身份证件(JSON字符串) | |
| idDocType | String(16) | Y | RESIDENT_ID_CARD | RESIDENT_ID_CARD:中国大陆居民-身份证 IDENTIFICATION_TYPE_OVERSEA_PASSPORT:其他国家或地区居民-护照 IDENTIFICATION_TYPE_HONGKONG_PASSPORT:国香港居民-来往内地通行证 IDENTIFICATION_TYPE_MACAO_PASSPORT:中国澳门居民-来往内地通行证 IDENTIFICATION_TYPE_TAIWAN_PASSPORT:中国台湾居民-来往大陆通行证 IDENTIFICATION_TYPE_HONGKONG_MACAO_RESIDENT-港澳居民证 IDENTIFICATION_TYPE_TAIWAN_RESIDENT-台湾居民证 IDENTIFICATION_TYPE_FOREIGN_RESIDENT-外国人居留证 |
| idDocName | String(32) | Y | 法人身份证姓名 | |
| idDocNumber | String(32) | Y | 法人身份证号 | |
| idDocCopy | String(64) | Y | 法人身份证正面照,图片上传请参考 图片上传 | |
| idDocNational | String(64) | Y | 法人身份证反面照,图片上传请参考 图片上传 | |
| docPeriodBegin | String(16) | Y | 法人身份证起始有效期,格式为YYYY-MM-DD | |
| docPeriodEnd | String(16) | Y | 法人身份证结束有效期,格式YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| idDocAddress | String(128) | Y | 法人证件上的居住地址,若证件上无,则传入法人实际居住地址 | |
| handDocImg | String(64) | N | 法人手持身份证照片,小微商户签约收单产品必填 | |
| businessLicenseInfo | String | N | 营业执照信息(JSON字符串) 企业/个体工商户/ 必填 | |
| merchantName | String(32) | Y | 营业执照商户名称 | |
| licenseNumber | String(32) | Y | 营业执照编号 | |
| licenseCopy | String(64) | Y | 营业执照图片,图片上传请参考 图片上传 | |
| licensePeriodBegin | String(16) | Y | 营业执照起始有效期,格式为YYYY-MM-DD | |
| licensePeriodEnd | String(16) | Y | 营业执照结束有效期,格式YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| certificateInfo | String | N | 登记证书信息(JSON字符串) 政府机关/事业单位/社会组织 必填 | |
| merchantName | String(32) | Y | 登记证书商户名称 | |
| certType | String(32) | Y | 登记证书类型 事业单位法人证书:PUBLIC_INSTITUTION 政府机关统一社会信用代码证书:GOVERNMENT_OFFICE 社会组织统一社会信用代码证书:SOCIAL_ORGANIZATION_01 社会团体法人登记证书:SOCIAL_ORGANIZATION_02 民办非企业单位登记证书:SOCIAL_ORGANIZATION_03 基金会法人登记证书:SOCIAL_ORGANIZATION_04 执业许可证/执业证:SOCIAL_ORGANIZATION_05 基层群众性自治组织特别法人统一社会信用代码证:SOCIAL_ORGANIZATION_06 农村集体经济组织登记证:SOCIAL_ORGANIZATION_07 农民专业合作社法人营业执照:SOCIAL_ORGANIZATION_08 宗教活动场所登记证:SOCIAL_ORGANIZATION_09 慈善组织公开募捐资格证书:SOCIAL_ORGANIZATION_10 香港企业登记证书:REGISTRATION_CERTIFICATE_HK 国外企业登记证书:REGISTRATION_CERTIFICATE_FR | |
| certNumber | String(32) | Y | 登记证编号 | |
| certCopy | String(64) | Y | 登记证图片,图片上传请参考 图片上传 | |
| certPeriodBegin | String(16) | Y | 登记证书起始有效期,格式为YYYY-MM-DD | |
| certPeriodEnd | String(16) | Y | 登记证书结束有效期,格式为YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| legalPerson | String(32) | Y | 登记证书法定代表人 | |
| companyAddress | String(256) | Y | 登记证书注册地址 | |
| taxCertCopy | String(64) | N | 税务登记证图片,图片上传请参考 图片上传 | |
| productInfos | String | N | 签约产品信息(JSON数组字符串) 产品定义 | |
| bizProductCode | String(32) | Y | 产品编码 | |
| feeType | String(32) | Y | 费率类型 单笔费率:SINGLE_FEE 阶梯费率:STAIR_FEE | |
| minFee | number(10,2) | Y | 保底值,阶梯费率生效 | |
| maxFee | number(10,2) | Y | 封顶值,阶梯费率生效 | |
| feeInfos | String | N | 费率信息,JSON字符串 | |
| feeValue | number(10,4) | Y | 费率值 | |
| minValue | number(10,2) | Y | 阶梯起始值,阶梯费率生效 | |
| maxValue | number(10,2) | Y | 阶梯结束值,阶梯费率生效 | |
| terminalInfos | String | N | 终端信息(JSON数组字符串) | |
| ticketName | String(32) | Y | 小票名称 | |
| terminalCount | number(1) | Y | POS终端数量 | |
| terminalCityId | String(16) | Y | POS终端安装所在市编码省市区编号, | |
| terminalDetailAddress | String(32) | Y | POS终端安装详细地址 | |
| businessInfo | String | N | 经营信息(JSON字符串) | |
| storeName | String(20) | N | 经营店铺名称,签约收单产品必填 | |
| storeEntrancePic | String(64) | N | 经营店铺门头照,签约收单产品必填,图片上传请参考 图片上传 | |
| frontDeskPic | String(64) | N | 经营店铺前台照,签约收单产品必填,图片上传请参考 图片上传 | |
| indoorPic | String(64) | N | 经营店铺内部照,签约收单产品必填,图片上传请参考 图片上传 | |
| storeCountyId | String(16) | Y | 经营场所在区编码省市区编号,签约收单产品必填 | |
| storeAddress | String(64) | Y | 经营场所详细地址,签约收单产品必填 | |
| wxCertificateLetterCopy | String(64) | N | 微信单位证明函,需要传入,图片上传请参考 图片上传 | |
| alipayCertificateLetterCopy | String(64) | N | 支付宝单位证明函,需要传入,图片上传请参考 图片上传 | |
| bankAccountInfo | String | Y | 结算银行账户信息(JSON字符串) | |
| bankAccountType | String(16) | Y | B | B:对公,C:对私 |
| accountName | String(32) | Y | 结算银行卡账户名称 | |
| bankAccount | String(20) | Y | 结算银行卡账户 | |
| bankName | String(32) | N | 结算银行名称,对公结算必填 银行列表 | |
| bankCityId | String(16) | Y | 结算银行卡分支行所在市编码 省市区编号,对公结算必填 | |
| bankBranchName | String(64) | N | 结算银行卡分支行名称,对公结算必填 | |
| bankPhoneNo | String(16) | N | 银行预留手机号 | |
| bankAccountPic | String(32) | Y | 对公开户许可证图片或者对私银行卡照片,图片上传请参考 图片上传 | |
| idDocNumber | String(32) | N | 企业或者个体工商户非法人结算持卡人身份证号必填 | |
| idDocCopy | String(64) | N | 企业或者个体工商户非法人结算持卡人身份证正面必填,图片上传请参考 图片上传 | |
| idDocNational | String(64) | N | 企业或者个体工商户非法人结算持卡人身份证反面照必填,图片上传请参考 图片上传 | |
| docPeriodBegin | String(16) | N | 企业或者个体工商户非法人结算持卡人身份证有效期起始时间,格式为YYYY-MM-DD | |
| docPeriodEnd | String(16) | N | 企业或者个体工商户非法人结算持卡人身份证有效期结束时间,格式为YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| autoWithdraw | String(16) | Y | N | 是否开通自动结算 [Y,N] 默认为不开通 N |
| mchBankAccountInfo | String | N | 同名银行账户信息(JSON字符串),非同名结算必传 | |
| bankAccountType | String(16) | Y | B | B:对公,C:对私,企业开户必须对公 |
| accountName | String(32) | Y | 银行卡账户名称,对公必须和营业执照上名称一致,个体工商户对私必须和法人名称一致 | |
| bankAccount | String(20) | Y | 银行卡账户 | |
| bankName | String(32) | N | 银行名称,对公结算必填 银行列表 | |
| bankCityId | String(16) | Y | 银行卡分支行所在市编码 省市区编号,对公结算必填 | |
| bankBranchName | String(64) | N | 银行卡分支行名称,对公结算必填 | |
| bankAccountPic | String(32) | Y | 对公开户许可证图片或者对私银行卡照片,图片上传请参考 图片上传 | |
| settlementInfo | String | N | 结算配置信息(JSON字符串) | |
| settleTime | int(2) | N | 结算时间[0、6、8、10],默认为0点结算 | |
| uboInfos | String | N | 受益人信息(JSON数组字符串),企业必传 | |
| idDocType | String(16) | Y | RESIDENT_ID_CARD | RESIDENT_ID_CARD:中国大陆居民-身份证 IDENTIFICATION_TYPE_OVERSEA_PASSPORT:其他国家或地区居民-护照 IDENTIFICATION_TYPE_HONGKONG_PASSPORT:国香港居民-来往内地通行证 IDENTIFICATION_TYPE_MACAO_PASSPORT:中国澳门居民-来往内地通行证 IDENTIFICATION_TYPE_TAIWAN_PASSPORT:中国台湾居民-来往大陆通行证 IDENTIFICATION_TYPE_HONGKONG_MACAO_RESIDENT-港澳居民证 IDENTIFICATION_TYPE_TAIWAN_RESIDENT-台湾居民证 IDENTIFICATION_TYPE_FOREIGN_RESIDENT-外国人居留证 |
| idDocName | String(32) | Y | 受益人证件姓名 | |
| idDocNumber | String(32) | Y | 受益人证件号 | |
| idDocCopy | String(64) | Y | 受益人证件正面照,图片上传请参考 图片上传 | |
| idDocNational | String(64) | Y | 受益人证件反面照,图片上传请参考 图片上传 | |
| docPeriodBegin | String(16) | Y | 受益人证件有效期开始时间,格式为YYYY-MM-DD | |
| docPeriodEnd | String(16) | Y | 受益人证件有效期结束时间,格式为YYYY-MM-DD,有效期永久时传入,2199-12-31 | |
| idDocAddress | String(128) | Y | 受益人证件上的地址或实际居住地址 | |
| additionInfo | String | N | 补充材料,图片id,图片上传请参考 图片上传 | |
| pageContractNo | String(32) | N | 纸质合同单号,纸质合同必填 | |
| pageContractPics | array | N | 纸质合同图片,纸质合同必填,图片上传请参考 图片上传 | |
| businessAdditionPics | array | N | 其他补充材料,图片上传请参考 图片上传 | |
| notifyUrl | String(256) | Y | 通知内容请参看 进件通知 | |
| notifyAccount | String(16) | N | N | 是否通知联系人用户名和登录名密码 [Y,N] 默认为不通知 N ) |
| signMode | String(16) | N | P | 签约方式 [P:纸质合同,E:电子合同] 签约产品必填,企业或者个体工商户非法人结算必须是电子合同 |
| nonceStr | String | Y | nGBXiNhZjBaFrMGIJAKJQQpfNiSGVjzy | 随机字符串 |
| signType | String | Y | RSA | 签名方式 |
| sign | String | Y | 签名 (见签名介绍) |
请求示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
响应参数
| 变量名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| returnCode | String | Y | SUCCESS | 返回码(SUCCESS/FAIL) |
| returnMsg | String | N | 返回消息(当returnCode为FAIL时使用) | |
| resultCode | String | Y | SUCCESS | 业务结果(SUCCESS/FAIL) |
| errorCode | String | N | 错误代码(当resultCode为FAIL时使用) | |
| errorCodeDes | String | N | 错误描述(当resultCode为FAIL时使用) | |
| applyId | String(31) | N | 申请单号 | |
| subMchId | String(16) | N | 子商户号 | |
| nonceStr | String | Y | nGBXiNhZjBaFrMGIJAKJQQpfNiSGVjzy | 随机字符串 |
| signType | String | Y | RSA | 签名方式 |
| sign | String | Y | 签名 |
响应示例
1 2 3 4 5 6 7 8 9 10 | |