接口介绍
根据APPID和设备编号获取设备支付Key,获得的设备Key用户调用支付相关接口。
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.device.key |
是 |
app_id |
String(32) |
应用ID |
是 |
device_no |
String(32) |
设备唯一标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:1.0 |
是 |
sign_type |
String(32) |
签名类型, 固定为:MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名 |
是 |
参数简介
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
success |
result |
boolean |
标识这次请求是否成功 |
请不要用这个值来判断收银是否成功,订单的结果以返回的order_status为准。 |
error_code |
result |
String(64) |
错误码 |
|
error_msg |
result |
String(16) |
错误码的详细说明 |
|
app_id |
data |
String(32) |
应用ID |
|
device_no |
data |
String(64) |
设备唯一标识 |
|
request_id |
data |
String(64) |
请求报文ID |
|
request_time |
data |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
数据返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
device_key |
data |
String(64) |
设备支付Key |
|
request_domain |
data |
String(64) |
采宝的订单号,最长64位 |
|
merchant_name |
data |
String(256) |
商户名称 |
|
store_name |
data |
String(256) |
门店名称 |
|
operator_name |
data |
String(256) |
收银员名称 |
返回值示例
{
"result": {
"success": true
}
,"data":{
"app_id":"BOPU",
"device_no":"1234566",
"request_id":"123456789123456",
"request_time":"20181224170247",
"response_time":"20181224170302",
"device_key": "abc123",
"request_domain": "http://openapi.caibaopay.com/gatewayOpen.htm",
"merchant_name":"我是商户名",
"store_name":"我是门店名",
"operator_name":"我是收银员名"
}
,"sign":"NH/qBDrbyn3ZQYe535dO74sZuw7JeZo6ht8hWRyEASeshIc2KE11bxhG5Qd4QdvlodZYBRunaclEOMM19ZCUWmu5lFGprMR5KjcXSlZ7ErPTn82V5y8j7DuuAH/3UnxV/E6ZWlu788ooQ3xTncNNDs3WivSKwOgJsnDLZbVrFaxUzK+RnMr2p5myLY4Qo4D9AV9afPbJJTBszpAybcu0GBPeilBe4TZX/iLgSYb1SRryhnwlf94cgTREWa8u/0tBV8XJmzlAxmmCZHJtjDJqSJ8aAktdj2Y3QrzunQ3a4I07D+UaXU+csQAxJsCILQi8ye2ke4N+xQPvjdDo+cb8yw=="
}
Js Demo
http://openapi.caibaopay.com/test/api/device/deviceKey.htm