接口介绍
本接口用于第三方创建商户,创建数量每个对接方都有限制(当前限制每天100个商户),如需大批量生成,需提前申请
该接口提供商户基本信息,具体签约资料在H5自助签约页面进行提交
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.merchant.create |
是 |
app |
String(32) |
接入商标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:2.0 |
是 |
sign_type |
String(32) |
签名类型 MD5、RSA,默认MD5 |
否 |
identity_type |
String(32) |
对接方唯一标示,默认USER_PHONE,可选USER_PHONE(手机号),SYSTEM_ID(系统ID) |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名、RSA256签名 |
是 |
参数简介
参数名 |
参数类型 |
参数介绍 |
是否必填 |
merchant_code |
String(32) |
对接方商户号 |
否 |
user_phone |
String(16) |
商户手机号 |
是 |
merchant_name |
String(32) |
商户名称 |
是 |
abbreviation |
String(32) |
商户简称 |
是 |
province |
String(16) |
省名称 (附录 /省/市/区/县名称对照表) |
否 |
city |
String(16) |
市名称 (附录 /省/市/区/县名称对照表) |
否 |
area |
String(16) |
区名称 (附录 /省/市/区/县名称对照表) |
否 |
sign_notify_url |
String(256) |
签约结果回调地址 |
是 |
注:merchant_code为调用方本地商户号,若传入则后续接口调用在选择merchant_code或cb_merchant_code时,可使用merchant_code作为商户标识。
sign_notify_url回调地址会返回签约状态,只有当sign_status
返回SUCCESS
才可以进行收款。
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
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 |
签名值 |
具体参照: 接口验签规则 |
数据返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
gateway_url |
data |
String(256) |
授权网关地址 |
|
merchant_qr_code |
data |
String(256) |
商户二维码地址 |
|
cb_merchant_code |
data |
String(32) |
该商户的采宝商户号 |
|
store_id |
data |
String(32) |
默认门店ID |
|
operator_id |
data |
String(32) |
默认收银员ID |
返回值举例
{
"data": {
"cb_merchant_code": "A00300270000018",
"gateway_url": "https: //gw1.caibaopay.com/h5/auth.html",
"merchant_qr_code": "https: //openapi.caibaopay.com/qr/store.htm?s=XXXX",
"operator_id": "9c93dbd49ba5f01274cdf38f395c2a71",
"request_id": "dcf2a0b5-5a8d-4ad9-aaa9-27333aa39742",
"request_time": "20190114151645",
"response_time": "20190114151727",
"store_id": "229117"
},
"result": {
"success": true
},
"sign": ""
}
js demo
http://openapi.caibaopay.com/test/api/v2/createMerchant.htm