接口地址
生产环境:https://cus.allinpay.com/cusapi/merchantapi/subbranch
测试环境:https://syb-test.allinpay.com/vsppcusapi/merchantapi/subbranch
使用场景:
对商户所属门店的增删改查操作
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
orgid |
代理商号 |
平台分配的代理商 |
否 |
15 |
|
cusid |
商户号 |
审核通过分配的通联商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的机构APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
reqtype |
请求类型 |
query/add/edit/del |
否 |
10 |
接口请求子类型 |
subbranchlist |
门店信息 |
门店列表的json |
是 |
4000 |
当reqtype为query时可为空 |
signtype |
签名类型 |
|
|
|
RSA/SM2 |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
其中门店列表subbranchlist的json信息为:
详情如下所示:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
branchno |
门店编号 |
进行修改、删除操作时按查询返回对应的branchno填写 |
是 |
4 |
reqtype为add时为空 |
branchname |
门店名称 |
|
否 |
60 |
同一商户名称唯一 |
branchaddr |
门店地址 |
|
否 |
150 |
|
contactperson |
门店联系人 |
|
否 |
32 |
|
contactphone |
门店联系人电话 |
|
否 |
32 |
|
districtcode |
所在区 |
|
否 |
10 |
见附录 |
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
SUCCESS-请求成功 |
retmsg |
返回码说明 |
|
是 |
100 |
|
trxstatus |
状态码 |
1000|1999 |
否 |
4 |
1000: 获取结果成功 1999:获取结果失败 |
orgid |
代理商号 |
|
否 |
15 |
与请求时一致 |
cusid |
商户号 |
|
否 |
15 |
与请求时一致 |
以下信息只有当retcode为SUCCESS时有返回 |
|||||
auditstatus |
状态码 |
|
|
|
状态码为00时,表示请求成功(增删改查) |
errmsg |
错误描述 |
|
是 |
100 |
|
subbranchlist |
门店信息列表json格式 |
|
是 |
|
仅reqtype为query时返回数据 |
addbranchs |
新增门店结果 |
0001:门店名称1#0002:门店名称2 |
是 |
1000 |
仅reqtype为add时返回数据 |