查询车牌状态接口

最新更新时间：2022.03.30

查询车牌是否开通了先离场后付费功能。
· 目前仅支持蓝牌和新能源车的先离场后付费服务，其他车牌暂不支持。

---

接口说明

请求URL： https://{domain}/os-base/trade/credit/carStatus/v1/open

请求方式： POST

请求参数 公共请求参数

参数名	必填	类型	说明
access_id	是	string	开发者唯一标识
sign_type	是	string	固定传RSA2
time_stamp	是	long	请求时间，Linux时间戳，单位毫秒
sign	是	string	签名结果
data	是	string	将业务参数转为JSON字符串，然后使用BASE64编码的数据

详细签名方法请阅读接口加密方案

名称	必填	类型	说明
carPlate	是	string	需要进行扣款的车牌号
carPlateColor	是	int	车牌颜色 1-蓝色 2-黄色 3-白色 4-黑色 5-绿色 6-黄绿双拼色 常量定义在SDK的TyhConstants.CarPlateColor中

公共响应参数

名称	必传	类型	说明
code	是	int	请求结果code,详细请参考错误码说明)
msg	是	string	请求结果描述，失败时会返回错误原因
data	否	object	请求结果返回的业务响应参数，若无业务参数则返回空

响应参数

名称	类型	说明
status	int	车牌是否可用 1可用 0不可用
subMessage	string	提示信息

SDK方法

// 创建上传数据client
TyhPaymentClient client = TyhPaymentClient.create(TyhOptions.builder()
    .accessId(ACCESS_ID)
    .secretKey(SECRET_KEY)
    .allowUpload(Boolean.TRUE)
    .build());

// 车牌先离场后付费功能是否可用
CreditPayCarStatusCmd cmd = CreditPayCarStatusCmd.builder()
    .carPlate("皖Axxxxx")
    .carPlateColor(TyhConstants.CarPlateColor.BLUE)
    .build();
Results<CreditPayCarStatusDto> result = client.creditCarStatus(cmd);
     

入参格式

{
  "carPlate": "皖Axxxxx",
  "carPlateColor": 1
}

出参格式：

{
  "code": 8888,
  "msg": "处理成功",
  "data": {
    "status": "1",
    "subMessage": "车牌可用"
  },
  "error": null
}

code 为 8888 表示操作成功，其它值则为失败，具体内容参见错误码说明。