接口说明
调用方:商户接入系统
接收方:银账通系统
功能:查询商户列表
请求地址及接口名
生产环境:https://fzxt-yzt-openapi.wangcaio2o.com
测试环境:https://fzxt-yzt-openapi.imageco.cn
接口名(method):merchant.mchlist
公共请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
app_id | string(32) | 是 | 接入方appId | 20210911888888888888888888 |
method | string(32) | 是 | 接口名 | bkfunds.split.apply |
format | string(16) | 是 | 报文格式,仅支持JSON | json |
charset | string(16) | 是 | 字符编码 | UTF-8 |
sign_type | string(8) | 是 | 签名算法类型,仅支持RSA2 | RSA2 |
timestamp | string(16) | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。服务端允许客户端请求最大时间误差为10分钟 | 2021-09-11 12:00:00 |
version | string(8) | 是 | 版本号 | 1.0 |
app_auth_token | string(128) | 否 | token | 01c9a4191bfd4609d26 |
sign | string(256) | 是 | 请求参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
biz_content | string | 是 | 业务请求参数,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 | {“file”:””,”type”:”1”} |
业务请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
sso_node_id | string | 是 | 机构id | |
merchant_id | Long | 否 | 翼码商户id | |
account_sub_type | string | 否 | 账户类型 0-收款账户 1-付款账户 | |
page_num | number | 否 | 页数(默认1) | |
page_size | number | 否 | 每页数量(默认10) |
范例:
{
"sso_node_id": "00061967",
"merchant_id": 1000000001116,
"account_sub_type": "0",
"page_num": 1,
"page_size": 10
}
请求示例
{
"sso_node_id": "00061967",
"merchant_id": 1000000001116,
"account_sub_type": "0",
"page_num": 1,
"page_size": 10
}",
"method": "merchant.mchlist",
"format": "json",
"sign": "bP6dfs2LgvpxhyeTS+VwfSp+26Pgi6VPLagYIGx5ENL5shQmXWBel56nxkDi22hoopKuqO3FbomxIuFMuMPDWuFzJCHLW2O9yTut+94Rx0f8ICikYVanMAhsaIIeMx0g9AdZzqP2IOou0xD7udmeXmCZqKw/h73+VzXM5aRtSPCeQI7zlKd2wyKmhvjdc9ujXZ5phNeZgdtjLm5tI2Xnq+XIh+6shnRS+4Q1LFo6ubgBsEBHpVo4dsJJSknj4q+9hc38nmpPUNLPIV154Z+WiZsAllXaHunrt5lsnixdrqr3VkkDwpfkH4JzZS0hIZi7CsfhePWgra1GfI/BbYRvwQ==",
"app_id": "202404221232028501746384896",
"sign_type": "RSA2",
"version": "1.0",
"timestamp": "2024-04-2815:09:29"
}
公共响应参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
request_id | string | 是 | 每次请求唯一id | 4e770f101c9a4191bfd4609d26c6e0bd |
code | integer | 是 | 返回码 | 10000 |
sign | string | 是 | 响应参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
业务响应参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
data | JSONObject | 否 | 业务数据 | |
success | boolean | 否 | 是否成功 | true |
data 业务数据 (JSONObject)
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
total | long | 否 | 总记录数 | 3 |
pages | integer | 否 | 总页数 | 1 |
page_num | integer | 否 | 页码 | 1 |
page_size | integer | 否 | 每页数量 | 10 |
size | integer | 否 | 当前页数量 | 8 |
start_row | long | 否 | 起始行 | 10 |
end_row | long | 否 | 结束行 | 19 |
pre_page | integer | 否 | 前一页 | 0 |
next_page | integer | 否 | 下一页 | 0 |
is_first_page | boolean | 否 | 是否为第一页 | true |
is_last_page | boolean | 否 | 是否为最后一页 | false |
has_previous_page | boolean | 否 | 是否有前一页 | false |
has_next_page | boolean | 否 | 是否有下一页 | false |
navigate_pages | integer | 否 | 导航页码数 | 1 |
navigatepage_nums | int[] | 否 | 所有导航页号 | 【[1,2] |
navigate_firse_page | integer | 否 | 导航条第一页 | 0 |
navigate_last_page | integer | 否 | 导航条最后一页 | 0 |
list | JSONArray | 否 | 商户列表 |
list 商户列表 (JSONArray)
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
id | Long | 是 | 商户号 | 1000000001066 |
name | string | 否 | 商户名称 | 叶良辰百货店 |
type | string | 否 | 商户类型: 01=自然人, 02=个体工商户, 03=企业商户 | 02 |
status | string | 否 | 商户状态, 0=关闭,1=正常 | 1 |
alias | String | 否 | 商户简称 | 叶良辰百货店 |
node_id | String | 是 | 平台号 | 1106 |
node_name | String | 否 | 平台名称 | 657060客户名称111 |
cloud_merchant_id | String | 否 | 当前生效的渠道商户号 | 4458000000136117 |
register_status | String | 否 | 进件状态:1=待处理(内部注册),2=审核中(网商预入驻),3=待激活(网商待激活),4=待签约(网商待待签约),5=进件成功,6=进件失败。 | 5 |
channel_status | String | 否 | 商户在第三方渠道的进件状态: 0=未进件, 1=待查询(待审核), 2=进件完成, 3-进件失败(审核失败) | 2 |
channel | String | 否 | 渠道:01=网商,02=平安 | 02 |
store_count | integer | 否 | 绑定门店数 | 1 |
created_at | Date | 否 | 创建时间 | 2025-05-15 12:53:43 |
is_platform | String | 否 | 商户身份:0=商户,1=平台 | 0 |
withdrawal_method | integer | 否 | 提现方式 0-自动结算 1-手动提现 | 0 |
account_sub_type | integer | 否 | 商户类型 0-收款账户 1-付款账户 | 0 |
响应示例
{
"merchant_mchlist_response": {
"request_id": "openapi_68bee38c8c244e78a6aabbf6e263346f",
"code": 10000,
"data": {
"total": 1,
"pages": 1,
"page_num": 1,
"page_size": 10,
"size": 1,
"start_row": 1,
"end_row": 10,
"pre_page": 0,
"next_page": 0,
"is_first_page": true,
"is_last_page": false,
"has_previous_page": false,
"has_next_page": true,
"navigate_pages": 0,
"navigatepage_nums": [],
"navigate_firse_page": 0,
"navigate_last_page": 0,
"list": [
{
"id": 1000000001066,
"name": "叶良辰百货店",
"type": "02",
"status": "1",
"alias": "叶良辰百货店",
"node_id": "1106",
"node_name": "657060客户名称111",
"cloud_merchant_id": "4458000000136117",
"register_status": "5",
"channel_status": "2",
"channel": "02",
"store_count": 0,
"created_at": "2025-05-15 12:53:43",
"is_platform": "0",
"withdrawal_method": 0,
"account_sub_type": "0"
}
},
"success": true
},
"sign": "N2XlAGX+GPXmN2rsPHOqexHWDXMt/GlNCKPNJCF1vEj9rEjZrc7fohbpayqE0hwiE7XU6TbVLPDnMcfO+LN/xHc0nUlAYT5oWvlXaS4ku9eZ9qmBylaJ+jWn8lDcGvPlmivRyRU5Qo7M28Nd92XRYPwpTXNOu+W+OCWiPfDgPPjjRnXaSIEVipqP8zo8a71aoeVt7MBIwID+YQEaRK2+Fs6+5reOJR86S2X4UeQo1L47KQ9ULOS0JpTkkMMn7ucjrzHOucbI8JsIg3TNGOZaooy1TJa8oX5TpII+y18DjkImy+YFBvqY/OFZvV2iqCFKF2mKIbpJT39x1eyJFxMJYQ=="
}