接口介绍
本接口用于第三方查询平台商户名下设备列表数据,高级服务商账号和普通服务商账号才能够调用此接口。
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.terminal.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签名 |
是 |
业务参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
merchant_code |
String(64) |
商户编码 |
必填 |
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
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处理过的,使用前请自行解码 |
设备信息描述
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
terminal_no |
list |
String |
设备编号 |
|
terminal_status |
list |
String |
设备状态 |
|
terminal_type |
list |
String |
设备类型 |
|
terminal_sub_type |
list |
String |
设备子类型 |
|
store_id |
list |
Long |
门店ID |
|
store_name |
list |
String |
门店名称 |
|
operator_code |
list |
String |
收银员编码 |
|
operator_name |
list |
String |
收银员名称 |
返回值举例
{
"data": {
"list": "W3sic3RvcmVfaWQiOjEyMDU4LCJzdG9yZV9uYW1lIjoi57O757uf6Zeo5bqXIiwidGVybWluYWxfbm8iOiJUWEFQMTE5MzYwMDA4NzNORDAwMTExMCIsInRlcm1pbmFsX3N0YXR1cyI6IkJJTkQiLCJ0ZXJtaW5hbF9zdWJfdHlwZSI6IlFJTkdXQV9QUk8iLCJ0ZXJtaW5hbF90eXBlIjoiQ0FJQkFPX1hJQU9CRUkifSx7InN0b3JlX2lkIjoxMjA1OCwic3RvcmVfbmFtZSI6Iuezu+e7n+mXqOW6lyIsInRlcm1pbmFsX25vIjoiSDlBVDJPUDlBMjEwMTQ3UEViR0Y2YzkiLCJ0ZXJtaW5hbF9zdGF0dXMiOiJCSU5EIiwidGVybWluYWxfc3ViX3R5cGUiOiJIU19UMiIsInRlcm1pbmFsX3R5cGUiOiJDQUlCQU9fWElBT0JFSSJ9XQ==",
"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/terminalList.htm