接口介绍
本接口适用于有自己签约页面的对接方,若没有签约页面,请移步H5自助签约页面,
本接口接受身份证、营业执照、银行卡信息为商户签约
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.merchant.sign |
是 |
app |
String(32) |
接入商标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:2.0 |
是 |
sign_type |
String(32) |
签名类型 MD5、RSA,默认MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名、RSA256签名 |
是 |
参数简介
参数名 |
参数类型 |
参数介绍 |
是否必填 |
merchant_code |
String(32) |
第三方商户号(第三方商户号和平台商户号至少填一个) |
否 |
cb_merchant_code |
String(32) |
平台商户号(第三方商户号和平台商户号至少填一个) |
否 |
company_type |
String(32) |
商户类型 COMPANY:企业; PERSONAL:个人; PERSONAL_COMPANY:个体工商户; |
是 |
channel |
String(32) |
签约渠道 MYBANK:银行渠道 WECHAT:官方微信渠道 |
是 |
merchant_name |
String(32) |
商户全称 |
是 |
abbreviation |
String(32) |
商户简称 |
是 |
trade_code |
String(32) |
行业类目信息(附录 行业类目信息表中的“类目编码”) |
是 |
province |
String(32) |
省份(省份和省份编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
city |
String(32) |
城市(城市和城市编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
area |
String(32) |
地区(地区和地区编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
province_code |
String(32) |
省份编码(省份和省份编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
city_code |
String(32) |
城市编码(城市和城市编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
area_code |
String(32) |
地区编码(地区和地区编码至少填一个)(附录 /省/市/区/县名称对照表) |
否 |
business_address |
String(255) |
经营地址 |
是 |
service_telephone |
String(32) |
客服电话 |
是 |
subscribe_appid |
String(32) |
关注公众号(主体必须与营业执照一致) |
否 |
contact_info |
String |
联系人信息 Base64 |
是 |
settlement_info |
String |
结算卡信息 Base64 |
是 |
organization_license |
String |
组织结构信息 Base64 |
非三证合一的个体/企业必填 |
business_license |
String |
营业执照信息 Base64 |
个体/企业必填 |
id_card_license |
String |
法人身份证信息 Base64 |
是 |
images |
String |
图片信息 Base64 |
是 |
|
|
|
参数名 |
参数类型 |
参数介绍 |
是否必填 |
email |
String(50) |
邮箱 |
是 |
name |
String(50) |
姓名 |
是 |
phone |
String(50) |
电话 |
是 |
position |
String(50) |
职位 |
否 |
wechat_id |
String(50) |
微信号 |
否 |
示例
{"email":"test@test.com","name":"联系人姓名","phone":"电话","position":"职位"}
settlement_info 结算信息JSON组成
参数名 |
参数类型 |
参数介绍 |
是否必填 |
bank_account_type |
String(50) |
结算类型(PERSON:法人对私,COMPANY:企业对公,COMPANY_UN_PERSON:企业非法人),默认:PERSON,只有银行通道支持企业非法人 |
否 |
bank_account_number |
String(50) |
银行卡卡号 |
是 |
bank_contact_line |
String(50) |
银行联行号附录 银行联行号 |
是 |
bank_reserved_mobile |
String(50) |
银行预留手机号 |
是 |
open_account_bank |
String(50) |
开户银行 |
是 |
branch_bank_name |
String(50) |
开户支行 |
是 |
open_account_name |
String(50) |
开户名称 |
是 |
open_account_cert_number |
String(50) |
开户人证件编号 |
选择性必填: bank_account_type为COMPANY_UN_PERSON时必填 |
open_account_cert_begin_time |
String(50) |
开户人证件有效开始时间 |
选择性必填: bank_account_type为COMPANY_UN_PERSON时必填 |
open_account_cert_end_time |
String(50) |
开户人证件有效结束时间 |
选择性必填: bank_account_type为COMPANY_UN_PERSON时需选择性填写,如果有结束日期则需要传,如果为长期,则不需要传 |
示例
{
"bank_account_type" : "COMPANY_UN_PERSON",
"bank_account_number": "6214855113079652",
"bank_contact_line": "102331005384",
"bank_reserved_mobile": "18158102600",
"branch_bank_name": "中国工商银行股份有限公司杭州东湖支行",
"open_account_bank": "招商银行",
"open_account_name": "王五",
"open_account_cert_number": "421022199011032123",
"open_account_cert_begin_time": "2018-01-02 00:00:00",
"open_account_cert_end_time": "2038-01-02 00:00:00",
}
organization_license 组织结构代码证JSON组成
参数名 |
参数类型 |
参数介绍 |
是否必填 |
license_name |
String(50) |
机构名称 |
是 |
license_number |
String(50) |
机构编码 |
是 |
begin_time |
String(50) |
有效开始时间 |
否 |
end_time |
String(50) |
有效结束时间 |
否 |
示例
{
"license_name": "杭州XX信息科技有限公司",
"license_number": "410182600085602",
"begin_time": "2015-03-10 00:00:00",
"end_time": "2025-03-10 00:00:00"
}
business_license 营业执照JSON组成
参数名 |
参数类型 |
参数介绍 |
是否必填 |
license_name |
String(50) |
机构名称 |
是 |
license_number |
String(50) |
机构编码 |
是 |
begin_time |
String(50) |
有效开始时间 |
是 |
end_time |
String(50) |
有效结束时间 |
否 |
business_range |
String(1024) |
经营范围/主营业务 |
否 |
province_code |
String(32) |
省份编码 |
否 |
city_code |
String(32) |
城市编码 |
否 |
area_code |
String(32) |
地区编码 |
否 |
license_address |
String(512) |
营业执照注册地址 |
是 |
示例
{
"license_name": "杭州XX信息科技有限公司",
"license_number": "410182600085602",
"begin_time": "2015-03-10 00:00:00",
"end_time": "2025-03-10 00:00:00",
"end_time": "2025-03-10 00:00:00",
"business_range": "教育辅导,教育培训。",
"province_code": "440000",
"city_code": "440300",
"area_code": "440304",
"license_address": "深圳市福田区沙头街道天安社区泰然五路6号天安数码城天经大厦七层7D737-A室"
}
id_card_license 法人身份证JSON组成
参数名 |
参数类型 |
参数介绍 |
是否必填 |
license_name |
String(50) |
机构名称 |
是 |
license_number |
String(50) |
机构编码 |
是 |
license_type |
String(50) |
证件类型 ID_CARD_FRONT:法人身份证;PASSPORT:法人护照;不传默认是法人身份证 |
否 |
begin_time |
String(50) |
有效开始时间 |
是 |
end_time |
String(50) |
有效结束时间 |
否 |
示例
{
"license_name": "王五",
"license_number": "33068320000101123X",
"license_type": "PASSPORT",
"begin_time": "2019-01-01 00:00:00",
"end_time": "2039-01-01 00:00:00"
}
images 图片数组JSON组成
参数名 |
参数类型 |
参数介绍 |
是否必填 |
image_type |
String(50) |
图片类型, 具体取值请参照:名词解释 |
是 |
image_url |
String(255) |
图片地址 |
是 |
说明
images 图片说明
参数名 |
参数介绍 |
是否必填 |
ID_CARD_FRONT |
身份证正面(头像面) |
是 |
ID_CARD_BACK |
身份证反面(国徽面) |
是 |
BUSINESS_LICENSE |
营业执照 |
个体工商户/企业必填 |
ORGANIZATION_CERTIFICATE |
组织机构代码证 |
非三证合一的个体工商户/企业必填 |
BUSINESS_PLACE_DOOR_HEAD |
经营场所门头照 |
是 |
BUSINESS_PLACE_CASHIER_DESK |
经营场所收银台照 |
是 |
BUSINESS_PLACE_INTERIOR |
经营场所内景照 |
是 |
OPEN_ACCOUNT_LICENSE |
开户许可证 |
对公结算必填 |
BANK_CARD |
银行卡照片 |
对私结算必填 |
HAND_HOLD_ID_CARD |
手持身份证 |
特定场景必填 |
BIG_PLATFORM_SETTLED |
主流餐饮平台入驻图 |
特定场景必填 |
AUTHORIZATION_LETTER |
非法人结算授权函照片 |
非法人结算必填, 授权书模板: |
SETTLE_ID_CARD_FRONT |
结算人身份证(头像面) |
非法人结算必填 |
SETTLE_ID_CARD_BACK |
结算人身份证(国徽面) |
非法人结算必填 |
示例
[{
"image_type": "ID_CARD_FRONT",
"image_url": "https://pic.caibaopay.com/open/upload/803297ad817f4bcfdcc6a39eb2ceb6d8.jpg"
}, {
"image_type": "ID_CARD_BACK",
"image_url": "https://pic.caibaopay.com/open/upload/924827317de777f9ae93955f00e01242.jpg"
}, {
"image_type": "BUSINESS_LICENSE",
"image_url": "https://pic.caibaopay.com/open/upload/d83c5c29b940be883f9ddb3cbf183cb3.jpg"
}, {
"image_type": "ORGANIZATION_CERTIFICATE",
"image_url": "https://pic.caibaopay.com/open/upload/ad3e2e0d49895fe43121d46ad6725cee.jpg"
}, {
"image_type": "BUSINESS_PLACE_DOOR_HEAD",
"image_url": "https://pic.caibaopay.com/open/upload/40785e6c08493ecaaa505d6fe2f8870c.jpg"
}, {
"image_type": "BUSINESS_PLACE_CASHIER_DESK",
"image_url": "https://pic.caibaopay.com/open/upload/40785e6c08493ecaaa505d6fe2f8870c.jpg"
}, {
"image_type": "BUSINESS_PLACE_INTERIOR",
"image_url": "https://pic.caibaopay.com/open/upload/40785e6c08493ecaaa505d6fe2f8870c.jpg"
}, {
"image_type": "OPEN_ACCOUNT_LICENSE",
"image_url": "https://pic.caibaopay.com/open/upload/6e515d3b4d5eace27048629b37f0fcfa.jpg"
}, {
"image_type": "BANK_CARD",
"image_url": "https://pic.caibaopay.com/open/upload/6e515d3b4d5eace27048629b37f0fcfa.jpg"
}, {
"image_type": "HAND_HOLD_ID_CARD",
"image_url": "https://pic.caibaopay.com/open/upload/cdff4273194d8946f191d34a5d09f54c.jpg"
}, {
"image_type": "BIG_PLATFORM_SETTLED",
"image_url": "https://pic.caibaopay.com/open/upload/dcb627eb1f00d2316715ad11dcbec95a.png"
}, {
"image_type": "AUTHORIZATION_LETTER",
"image_url": "https://pic.caibaopay.com/open/upload/dcb627eb1f00d2316715ad11dcbec95a.png"
}, {
"image_type": "SETTLE_ID_CARD_FRONT",
"image_url": "https://pic.caibaopay.com/open/upload/803297ad817f4bcfdcc6a39eb2ceb6d8.jpg"
}, {
"image_type": "SETTLE_ID_CARD_BACK",
"image_url": "https://pic.caibaopay.com/open/upload/924827317de777f9ae93955f00e01242.jpg"
}]
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
success |
result |
boolean |
标识这次请求是否成功 |
|
error_code |
result |
String(64) |
错误码 |
|
error_msg |
result |
String(16) |
错误码的详细说明 |
|
request_id |
data |
String(64) |
请求报文ID |
|
request_time |
data |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
返回值说明
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
|
返回值举例
{
"data": {
"request_id": "5ad1f599-8e73-4c24-9fbb-d5fbd732d14c",
"request_time": "20190114150144",
"response_time": "20190114150206"
},
"result": {
"success": true
},
"sign": ""
}
js demo
http://agent.caibaopay.com/test/api/v2/signMerchant.htm