接口介绍

本接口用于第三方查询平台账号下的商户列表数据,高级服务商账号和普通服务商账号才能够调用此接口。

参数简介

公共参数

参数名 参数类型 参数介绍 是否必填
command String(32) 接口名,固定为:open.api.merchant.list
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签名

业务参数

参数名 参数类型 参数介绍 是否必填
agent_code String(64) 普通服务商编号,当接入商标识为高级服务商查询时必填 特殊可选填
salesman_id Long 业务员ID,必填 必填

返回值说明

公共返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
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 签名值 具体参照: 接口验签规则

数据返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
list data String 商户列表字符串 返回的列表字符串是经过Base64处理过的,使用前请自行解码

商户信息描述

参数名 所属结构 返回值类型 返回值说明 特殊备注
merchant_code list String 商户编码
merchant_name list String 商户名称
province_code list String 省份编码
city_code list String 城市编码
area_code list String 地区编码
prov_city_area list String 省份城市地区文字拼接,如:浙江省 杭州市 西湖区
address list String 地址
agent_code list String 服务商编码
ext_merchant_code list String 外部商户编码
ext_merchant_name list String 外部商户编码

返回值举例

{
    "data": {
        "list": "W3siYWRkcmVzcyI6IjM0NSIsImFnZW50X2NvZGUiOiJIMTQ4IiwiYXJlYV9jb2RlIjoiMzQwODIyIiwiY2l0eV9jb2RlIjoiMzQwODAwIiwiZXh0X21lcmNoYW50X2NvZGUiOm51bGwsImV4dF9tZXJjaGFudF9uYW1lIjpudWxsLCJtZXJjaGFudF9jb2RlIjoiTTEwMTA1NTYwMDAwMDAxIiwibWVyY2hhbnRfbmFtZSI6IkEwMDPllYbmiLcxMDIxMDkiLCJwcm92X2NpdHlfYXJlYSI6IuWuieW+veecgSDlronluobluIIg5oCA5a6B5Y6/IiwicHJvdmluY2VfY29kZSI6IjM0MDAwMCJ9LHsiYWRkcmVzcyI6IuWYu+WYu+WYu+WYuyIsImFnZW50X2NvZGUiOiJIMTQ4IiwiYXJlYV9jb2RlIjoiMzQwODAzIiwiY2l0eV9jb2RlIjoiMzQwODAwIiwiZXh0X21lcmNoYW50X2NvZGUiOm51bGwsImV4dF9tZXJjaGFudF9uYW1lIjpudWxsLCJtZXJjaGFudF9jb2RlIjoiSDE0ODA1NTYwMDAwMDAxIiwibWVyY2hhbnRfbmFtZSI6IkEwMDPllYbmiLcxMDIxMDciLCJwcm92X2NpdHlfYXJlYSI6IuWuieW+veecgSDlronluobluIIg5aSn6KeC5Yy6IiwicHJvdmluY2VfY29kZSI6IjM0MDAwMCJ9LHsiYWRkcmVzcyI6IjIyMjIyIiwiYWdlbnRfY29kZSI6IkgxNDgiLCJhcmVhX2NvZGUiOiIzNTA5MjIiLCJjaXR5X2NvZGUiOiIzNTA5MDAiLCJleHRfbWVyY2hhbnRfY29kZSI6bnVsbCwiZXh0X21lcmNoYW50X25hbWUiOm51bGwsIm1lcmNoYW50X2NvZGUiOiJIMTQ4MDU5MzAwMDAwMDIiLCJtZXJjaGFudF9uYW1lIjoiQTAwM+WVhuaItzEwMjA1NiIsInByb3ZfY2l0eV9hcmVhIjoi56aP5bu655yBIOWugeW+t+W4giDlj6TnlLDljr8iLCJwcm92aW5jZV9jb2RlIjoiMzUwMDAwIn0seyJhZGRyZXNzIjoiMzQzNDM0IiwiYWdlbnRfY29kZSI6IkgxNDgiLCJhcmVhX2NvZGUiOiIzNTA5MjIiLCJjaXR5X2NvZGUiOiIzNTA5MDAiLCJleHRfbWVyY2hhbnRfY29kZSI6bnVsbCwiZXh0X21lcmNoYW50X25hbWUiOm51bGwsIm1lcmNoYW50X2NvZGUiOiJIMTQ4MDU5MzAwMDAwMDEiLCJtZXJjaGFudF9uYW1lIjoiQTAwM+WVhuaItzEwMjA1NSIsInByb3ZfY2l0eV9hcmVhIjoi56aP5bu655yBIOWugeW+t+W4giDlj6TnlLDljr8iLCJwcm92aW5jZV9jb2RlIjoiMzUwMDAwIn0seyJhZGRyZXNzIjoiMTIzIiwiYWdlbnRfY29kZSI6IkgxNDgiLCJhcmVhX2NvZGUiOiIxMTAyMjgiLCJjaXR5X2NvZGUiOiIxMTAyMDAiLCJleHRfbWVyY2hhbnRfY29kZSI6bnVsbCwiZXh0X21lcmNoYW50X25hbWUiOm51bGwsIm1lcmNoYW50X2NvZGUiOiJIMTQ4MDAxMDAwMDAwMDEiLCJtZXJjaGFudF9uYW1lIjoiQTAwM+WVhuaItzEwMjA1NCIsInByb3ZfY2l0eV9hcmVhIjoi5YyX5LqsIOWMl+S6rOmDiuWOvyDlr4bkupHljr8iLCJwcm92aW5jZV9jb2RlIjoiMTEwMDAwIn1d",
        "request_id": "dcf2a0b5-5a8d-4ad9-aaa9-27333aa39742",
        "request_time": "20190114151645",
        "response_time": "20190114151727"
    },
    "result": {
        "success": true
    },
    "sign": ""
}

js demo

http://openapi.caibaopay.com/test/api/v2/merchantList.htm

results matching ""

    No results matching ""