API清单
编号 | API名称 | 请求路径 | 请求方法 | 版本1 |
---|---|---|---|---|
1 | 套餐列表查询接口 | /v2/smart-parkinglot/xlink-card/card-package?data={data} | GET | v1.0.0 |
2 | 月卡申请新增接口 | /v2/smart-parkinglot/xlink-card/apply | POST | v1.0.0 |
3 | 月卡申请详情查询接口 | /v2/smart-parkinglot/xlink-card/apply/{id} | GET | v1.0.0 |
4 | 月卡订单记录查询接口 | /v2/smart-parkinglot/xlink-card/car-order?data={data} | GET | v1.0.0 |
5 | 月卡订单详情查询接口 | /v2/smart-parkinglot/xlink-card/car-order/{id} | GET | v1.0.0 |
6 | 月卡通用查询接口 | /v2/smart-parkinglot/xlink-card/month-card?data={data} | GET | v1.0.0 |
7 | 月卡新增接口 | /v2/smart-parkinglot/xlink-card/month-card | POST | v1.0.0 |
8 | 月卡修改接口 | /v2/smart-parkinglot/xlink-card/month-card | PUT | v1.0.0 |
9 | 月卡注销接口 | /v2/smart-parkinglot/xlink-card/month-card/cancel | PUT | v1.0.0 |
10 | 月卡续期接口 | /v2/smart-parkinglot/xlink-card/month-card/delay | PUT | v1.0.0 |
11 | 月卡详情单表查询 | /v2/smart-parkinglot/xlink-card/month-card/{id} | GET | v1.0.0 |
12 | 更改月卡车辆 | /v2/smart-parkinglot/xlink-card/month-card/car-change | POST | v1.0.0 |
13 | 月卡车位修改接口 | /v2/smart-parkinglot/xlink-card/month-card | PUT | v1.0.0 |
14 | 产权月卡列表查询 | /v2/smart-parkinglot/xlink-card/month-card?data={data} | GET | v1.0.0 |
15 | 卡类型通用查询 | /v2/smart-parkinglot/xlink-card/card-type?data={data} | GET | v1.0.0 |
16 | 查看月卡排队情况 | /v2/smart-parkinglot/xlink-card/apply/card-queue/{cardTypeId} | GET | v1.0.0 |
17 | 月卡信息列表查询-app端 | /v2/smart-parkinglot/xlink-card/month-card/info/list?data={data} | GET | v1.0.0 |
18 | 月卡申请订单支付确认 | /v2/smart-parkinglot/xlink-card/apply/pay-confirm | POST | v1.0.0 |
19 | 月卡续期 | /v2/smart-parkinglot/xlink-card/month-card/delay | PUT | v1.0.0 |
20 | 月卡注销 | /v2/smart-parkinglot/xlink-card/month-card/cancel | v1.0.0 | |
21 | 月卡订单记录查询 | v1.0.0 | ||
22 | 退费订单通用查询 | v1.0.0 | ||
23 | 费率通用查询 | v1.0.0 | ||
24 | 费率单表查询 | v1.0.0 | ||
25 | 费率列表查询 | v1.0.0 | ||
26 | 获取产权月卡申请时有效日期 | v1.0.0 | ||
27 | 产权月卡续期 | v1.0.0 | ||
28 | 获取延期时有效日期和应付金额 | v1.0.0 | ||
29 | 29、查询可退费订单 | v2/smart-parkinglot/xlink-payment/card-order | ||
30 | 30、查询月卡退费记录 | v2/smart-parkinglot/xlink-card/refund-record | ||
31 | 31、查询银行列表 | v2/smart-parkinglot/xlink-card/refund-record/listBanks | ||
32 | 32、发起退费申请 | /v2/smart-parkinglot/xlink-card/refund-record |
1 月卡业务
套餐列表查询接口
请求路径
GET /v2/smart-parkinglot/xlink-card/card-package?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 否 | string | ID | |
project_id | 是 | string | 项目ID | |
parkinglot_id | 否 | string | 停车场ID |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
project_id | 是 | string | 项目ID | |
project_name | 是 | string | 项目名称 | |
parkinglot_id | 是 | string | 停车场ID | |
parkinglot_no | 是 | string | 停车场编码 | |
name | 是 | string | 套餐名称 | |
card_type_id | 是 | string | 卡类型标识 | |
cycle_rule | 是 | integer | 周期规则 | |
apply_ways | 是 | array | 可办理方式 | |
expense_rate_id | 是 | string | 费率标识 | |
discount | 是 | double | 折扣比例,单位% | |
min_duration | 是 | integer | 可办理最小限额 | |
max_limit_way | 是 | integer | 最大限额方式 | 1、按时间单位 2、固定时间 |
max_duration | 是 | integer | 最大月份 | |
max_fixed_date | 是 | date | 最大续费日期 | |
limit_area_ids | 是 | array | 限行区域标识 | |
rate_effective_date | 是 | date | 套餐有效开始时间 |
月卡申请新增接口
请求路径
POST /v2/smart-parkinglot/xlink-card/apply/card-apply
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
apply_mode | true | integer | 申请方式 | APP/0 后台/1 |
car_ids | true | array | 车辆标识 | |
car_owner_id | true | string | 车主标识 | |
card_package_id | true | string | 套餐标识 | |
expection_location | false | string | 期望位置 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | string | 申请标识 |
月卡申请详情查询接口
请求路径
GET /v2/smart-parkinglot/xlink-card/apply/{id}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 否 | string | ID |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
project_id | 是 | string | 项目ID | |
project_name | 是 | string | 项目名称 | |
parkinglot_id | 是 | string | 停车场ID | |
parkinglot_no | 是 | string | 停车场编码 | |
user_id | 是 | integer | 用户ID | |
user_type | 是 | integer | 用户类型 | |
expect_location | 否 | string | 期望位置 | |
expect_effective_date | 是 | date | 期望生效时间 | |
gender | 否 | integer | 性别 | |
house_info | 否 | string | 房源信息 | |
card_package_id | 是 | string | 套餐标识 | |
charge | 否 | long | 费用 | |
pay_type | 否 | integer | 支付方式 | |
car_infos | 是 | map | 车辆信息 | |
car_infos.car_plate_no | 是 | string | 车牌号码 | |
car_infos.car_plate_no | 是 | string | 车牌号码 | |
car_infos.brand_model | 否 | string | 品牌型号 | |
car_infos.car_owner_name | 是 | string | 车主姓名 | |
car_infos.tel | 是 | string | 电话 | |
parking_space_ids | 是 | array | 车位标识 | |
card_type_id | 是 | string | 卡类型标识 | |
card_type | 是 | string | 卡类型 |
月卡订单记录查询接口
请求路径
GET /v2/smart-parkinglot/xlink-card/car-order?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 否 | string | ID | |
card_id | ||||
project_id | 是 | string | 项目ID | |
parkinglot_id | 否 | string | 停车场ID | |
user_id | 是 | string | 用户ID |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
project_id | 是 | string | 项目ID | |
project_name | 是 | string | 项目名称 | |
parkinglot_id | 是 | string | 停车场ID | |
parkinglot_no | 是 | string | 停车场编码 | |
card_id | 是 | string | 卡ID | |
owner_name | 是 | string | 车主姓名 | |
card_package_name | 是 | string | 套餐名称 | |
card_package_id | 是 | string | 套餐标识 | |
card_type | 是 | string | 月卡类型 | |
parking_space_ids | 是 | array | 车位标识 | |
begin_date | 是 | date | 开始时间 | |
end_date | 是 | date | 结束时间 | |
apply_date | 是 | date | 申卡日期 | |
charge_type | 是 | integer | 费用类型 | |
bill_payable | 是 | long | 应收金额 | |
roll_money | 是 | long | 回滚金额 | |
coupon_no | 是 | string | 优惠券编号 | |
car_place_names | 是 | array | 车位名称 | |
charge_unit | 是 | integer | 收费单位 | |
expense_base | 是 | long | 费用基数 | |
fixed_card_count | 是 | integer | 购买时间 | |
card_type_id | 是 | string | 卡类型标识 | |
apply_id | 是 | string | 申请标识 | |
payment_date | 否 | date | 缴费完成时间 | |
real_pay | 否 | long | 实付金额 |
月卡订单详情查询接口
请求路径
GET /v2/smart-parkinglot/xlink-card/car-order/{id}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 否 | string | ID |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
project_id | 是 | string | 项目ID | |
project_name | 是 | string | 项目名称 | |
parkinglot_id | 是 | string | 停车场ID | |
parkinglot_no | 是 | string | 停车场编码 | |
card_id | 是 | string | 卡ID | |
owner_name | 是 | string | 车主姓名 | |
card_package_name | 是 | string | 套餐名称 | |
card_package_id | 是 | string | 套餐标识 | |
card_type | 是 | string | 月卡类型 | |
parking_space_ids | 是 | array | 车位标识 | |
begin_date | 是 | date | 开始时间 | |
end_date | 是 | date | 结束时间 | |
apply_date | 是 | date | 申卡日期 | |
charge_type | 是 | integer | 费用类型 | |
bill_payable | 是 | long | 应收金额 | |
roll_money | 是 | long | 回滚金额 | |
coupon_no | 是 | string | 优惠券编号 | |
car_place_names | 是 | array | 车位名称 | |
charge_unit | 是 | integer | 收费单位 | |
expense_base | 是 | long | 费用基数 | |
fixed_card_count | 是 | integer | 购买时间 | |
card_type_id | 是 | string | 卡类型标识 | |
apply_id | 是 | string | 申请标识 | |
payment_date | 否 | date | 缴费完成时间 | |
bill_payable | 是 | long | 应付金额 | |
real_pay | 否 | long | 实付金额 |
月卡通用查询接口
请求路径
GET /v2/smart-parkinglot/xlink-card/month-card?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
car_ids | false | array | car_ids | |
card_type | false | string | 卡类型 | |
card_type_id | false | string | 卡类型标识 | |
effective_date_begin | false | string | 有效期开始时间 | |
effective_date_end | false | string | 有效期截止时间 | |
id | false | string | 月卡id | |
owner_id | false | string | 车主ID | |
parking_space_ids | false | array | 车位 | |
parkinglot_id | false | string | 停车场ID | |
project_id | false | string | 项目id |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | object | 数据 | |
data.count | false | integer | 总数 | |
data.list | false | array | 数据列表 | |
data.list.apply_date | false | string | 申卡日期 | |
data.list.car_ids | false | array | 车辆标识数组 | |
data.list.car_package_id | false | string | 套餐标识 | |
data.list.card_type | false | string | 卡类型 | |
data.list.card_type_id | false | string | 卡类型标识 | |
data.list.create_by | false | string | 创建人名称 | |
data.list.create_date | false | string | 创建日期 | |
data.list.effective_date_begin | false | string | 有效期开始时间 | |
data.list.effective_date_end | false | string | 有效期截止时间 | |
data.list.id | false | string | id | |
data.list.is_cancel | false | boolean | 是否注销 | |
data.list.limit_area_ids | false | array | 限行区域标识 | |
data.list.ori_effective_date_end | false | string | 注销前的到期时间 | |
data.list.owner_id | false | string | 车主ID | |
data.list.owner_name | false | string | 车主姓名 | |
data.list.parking_space_ids | false | array | 车位 | |
data.list.parkinglot_id | false | string | 停车场ID | |
data.list.parkinglot_name | false | string | 停车场名称 | |
data.list.parkinglot_no | false | string | 停车场编号 | |
data.list.project_id | false | string | 项目id | |
data.list.project_name | false | string | 项目名称 | |
data.list.update_by | false | string | 更新人名称 | |
data.list.update_date | false | string | 更新日期 |
月卡新增接口
请求路径
POST /v2/smart-parkinglot/xlink-card/month-card
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
project_id | 是 | string | 项目ID | |
parkinglot_id | 是 | string | 停车场ID | |
area_id | 是 | string | 区域ID | |
owner_id | 是 | string | 车主ID | |
owner_name | 是 | string | 车主姓名 | |
owner_tel | 否 | string | 车主电话 | |
certificate_type | 否 | integer | 车主证件类型 | |
certificate_no | 否 | string | 车主证件号码 | |
certificate_pic | 否 | string | 车主证件图片 | |
fixed_card_type | 是 | integer | 固定卡类型 | |
apply_mode | 是 | integer | 办理方式 | |
effective_date_begin | 是 | date | 有效期开始时间 | |
effective_date_end | 是 | date | 有效期截止时间 | |
car_package_id | 是 | string | 套餐标识 | |
parking_space_ids | 是 | array | 车位信息 | |
car_infos | 是 | array | 车辆信息 | |
card_package_name | 是 | string | 套餐名称 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | 是 | array | 返回的数据,非查询类请求,该字段为空 |
月卡修改接口
请求路径
PUT /v2/smart-parkinglot/xlink-card/month-card
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
owner_id | 是 | string | 车主ID | |
owner_name | 是 | string | 车主姓名 | |
owner_tel | 否 | string | 车主电话 | |
certificate_type | 否 | integer | 车主证件类型 | |
certificate_no | 否 | string | 车主证件号码 | |
parking_space_ids | 是 | array | 车位信息 | |
car_infos | 是 | array | 车辆信息 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | 是 | array | 返回的数据,非查询类请求,该字段为空 |
月卡注销接口
请求路径
PUT /v2/smart-parkinglot/xlink-card/month-card/cancel
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | 是 | array | 返回的数据,非查询类请求,该字段为空 |
月卡续期接口
请求路径
PUT /v2/smart-parkinglot/xlink-card/month-card/delay
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | ID | |
effective_date_begin | 否 | date | 有效期开始时间 | |
effective_date_end | 是 | date | 有效期截止时间 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | 是 | array | 返回的数据,非查询类请求,该字段为空 |
月卡详情单表查询
请求路径
GET /v2/smart-parkinglot/xlink-card/month-card/{id}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | true | string | 月卡标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | object | 数据 | |
data.apply_date | false | string | 申卡日期 | |
data.car_ids | false | array | 车辆标识数组 | |
data.car_package_id | false | string | 套餐标识 | |
data.card_type | false | string | 卡类型 | |
data.card_type_id | false | string | 卡类型标识 | |
data.create_by | false | string | 创建人名称 | |
data.create_date | false | string | 创建日期 | |
data.effective_date_begin | false | string | 有效期开始时间 | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 0时区时间 |
data.effective_date_end | false | string | 有效期截止时间 | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 0时区时间 |
data.id | true | string | 月卡标识 | |
data.is_cancel | false | boolean | 是否注销 | |
data.limit_area_ids | false | array | 限行区域标识 | |
data.ori_effective_date_end | false | string | 注销前的到期时间 | |
data.owner_id | false | string | 车主ID | |
data.owner_name | false | string | 车主姓名 | |
data.parking_space_ids | false | array | 车位标识数组 | |
data.parkinglot_id | false | string | 停车场ID | |
data.parkinglot_name | false | string | 停车场名称 | |
data.parkinglot_no | false | string | 停车场编号 | |
data.project_id | false | string | 项目id | |
data.project_name | false | string | 项目名称 | |
data.update_by | false | string | 更新人名称 | |
data.update_date | false | string | 更新日期 |
更改月卡车辆
请求路径
PUT /v2/smart-parkinglot/xlink-card/month-card/car-change
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
car_ids | true | array | 车辆标识数组 | |
month_card_id | true | string | 月卡标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | true | boolean | 是否成功 |
错误码 | 描述 |
---|---|
20301001 | 存在订单未支付,无法绑定 |
月卡车位修改接口
请求路径
PUT /v2/smart-parkinglot/xlink-card/month-card
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | 是 | string | 月卡ID | |
parking_space_ids | 是 | array | 车位信息 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | 是 | int | HTTP状态码 | |
code | 是 | string | 错误码,000000表示请求成功 | |
msg | 是 | string | 提示内容 | |
data | 是 | object | 月卡内容 |
产权月卡列表查询
调用1.8接口,根据card_type_id(调用4.6卡类型通用查询接口,根据card_type、project_id获取id)、owner_id、project_id调用该接口
卡类型通用查询
请求路径
GET /v2/smart-parkinglot/xlink-card/card-type?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
authorize_obj | false | integer | 授权对象 | |
card_type | false | string | 卡类型 | |
id | false | string | id | |
max_publish_num | false | integer | 最大发行量 | |
parkinglot_id | false | string | 停车场ID | |
project_id | false | string | 项目id |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | ref | 数据 | |
data.count | false | integer | 总数 | |
data.list | false | array | 数据列表 | |
data.list.authorize_obj | false | integer | 授权对象 | |
data.list.card_type | false | string | 卡类型 | |
data.list.create_by | false | string | 创建人名称 | |
data.list.create_date | false | string | 创建日期 | |
data.list.id | false | string | id | |
data.list.max_publish_num | false | integer | 最大发行量 | |
data.list.parkinglot_id | false | string | 停车场ID | |
data.list.parkinglot_name | false | string | 停车场名称 | |
data.list.parkinglot_no | false | string | 停车场编号 | |
data.list.project_id | false | string | 项目id | |
data.list.project_name | false | string | 项目名称 | |
data.list.update_by | false | string | 更新人名称 | |
data.list.update_date | false | string | 更新日期 |
查看月卡排队情况
请求路径
GET /v2/smart-parkinglot/xlink-card/apply/card-queue/{cardTypeId}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
cardTypeId | true | string | 卡类型标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | boolean | 是否需要排队 |
月卡信息列表查询-app端
请求路径
GET /v2/smart-parkinglot/xlink-card/month-card/info/list?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
car_owner_id | true | string | 车主标识 | |
project_id | true | string | 项目标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | array\ | 数据 | |
data.apply_duration | false | integer | 月卡时长 | |
data.apply_id | false | string | 申请标识 | |
data.cancel_apply_date | false | string | 注销申请日期 | |
data.car_ids | false | array | 车辆标识数组 | |
data.car_place_ids | false | array | 车位标识数组 | |
data.card_package_id | false | string | 套餐标识 | |
data.card_package_name | false | string | 套餐名称 | |
data.card_status | false | integer | 月卡状态 0-排队中/1-审核中/2-待支付/3-支付超时/4-未生效/5-生效中/6-已失效/7-已拒绝/8-已取消申请/9-已取消支付 | |
data.card_type | false | string | 卡类型 | |
data.card_type_id | false | string | 卡类型标识 | |
data.charge | false | integer | 费用 | |
data.charge_unit | false | integer | 收费单位 | |
data.charge_way | false | integer | 收费方式 | |
data.create_date | false | string | 创建时间 | |
data.effective_date_begin | false | string | 有效开始时间 | |
data.effective_date_end | false | string | 有效结束时间 | |
data.expection_location | false | string | 期望位置 | |
data.expense_base | false | integer | 费用基数 | |
data.info_type | false | integer | 数据类型 0-申请/1-订单/2-月卡 | |
data.is_cancel | false | boolean | 是否注销 | |
data.month_card_id | false | string | 月卡标识 | |
data.order_create_date | false | string | 订单创建日期 | |
data.order_id | false | string | 订单标识 | |
data.ori_effective_date_end | false | string | 注销前有效结束时间 | |
data.project_id | false | string | 项目标识 | |
data.project_name | false | string | 项目名称 |
月卡申请订单支付确认
请求路径
POST /v2/smart-parkinglot/xlink-card/apply/pay-confirm
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
bill_payable | true | long | 应付金额 | |
comment | false | string | 备注 | |
effective_date_begin | true | string | 有效开始时间 | |
effective_date_end | true | string | 有效结束时间 | |
order_id | true | string | 订单标识 | |
pay_type | true | integer | 支付方式 | |
real_pay | true | long | 实收金额,单位为分 | |
apply_mode | false | int | 申请方式,不传默认为管理台 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | object | 数据 |
月卡续期
请求路径
POST /v2/smart-parkinglot/xlink-card/apply/card-repurchase
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
apply_duration | true | integer | 办理时长 | |
apply_mode | true | integer | 申请方式 | |
bill_payable | true | long | 应收金额,单位为分 | |
comment | false | string | 备注 | |
effective_date_begin | true | string | 有效开始时间 | |
effective_date_end | true | string | 有效结束时间 | |
month_card_id | true | string | 月卡标识 | |
pay_type | true | integer | 支付类型 | |
real_pay | true | long | 实收金额,单位为分 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
code | true | string | 错误码 | |
data | true | object | 数据 |
月卡注销
请求路径
POST /v2/smart-parkinglot/xlink-card/month-card/cancel
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
apply_mode | true | integer | 申请方式 | |
cancel_date | true | date | 销卡日期 | yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 0时区时间 |
month_card_id | true | string | 月卡标识 | |
refund_unit | true | integer | 退费单位 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
code | true | string | 错误码 | |
data | true | boolean | 是否成功 |
月卡订单记录查询
根据月卡标识调用1.4月卡订单通用查询接口,条件为已缴费状态的订单 根据月卡标识调用退费订单通用查询接口
费率通用查询
请求路径
GET /v2/smart-parkinglot/xlink-card/expense-rate?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
data | true | string | data |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
data | false | object | 数据 | |
data.count | false | integer | 总数 | |
data.list | false | array | 数据列表 | |
data.list.charge_unit | false | integer | 收费单位 | |
data.list.charge_way | false | integer | 收费方式 | |
data.list.create_by | false | string | 创建人名称 | |
data.list.create_date | false | string | 创建日期 | |
data.list.expense_base | false | integer | 费用基数,单位为分 | |
data.list.id | false | string | id | |
data.list.name | false | string | 费率名称 | |
data.list.parkinglot_id | false | string | 停车场ID | |
data.list.parkinglot_name | false | string | 停车场名称 | |
data.list.parkinglot_no | false | string | 停车场编号 | |
data.list.project_id | false | string | 项目id | |
data.list.project_name | false | string | 项目名称 | |
data.list.refund_unit | false | integer | 退费单位 | |
data.list.update_by | false | string | 更新人名称 | |
data.list.update_date | false | string | 更新日期 |
费率单表查询
请求路径
GET /v2/smart-parkinglot/xlink-card/expense-rate/{id}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
id | true | string | id |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | object | 数据 | |
data.charge_unit | false | integer | 收费单位 | |
data.charge_way | false | integer | 收费方式 | |
data.create_by | false | string | 创建人名称 | |
data.create_date | false | string | 创建日期 | |
data.expense_base | false | integer | 费用基数,单位为分 | |
data.id | false | string | id | |
data.name | false | string | 费率名称 | |
data.parkinglot_id | false | string | 停车场ID | |
data.parkinglot_name | false | string | 停车场名称 | |
data.parkinglot_no | false | string | 停车场编号 | |
data.project_id | false | string | 项目id | |
data.project_name | false | string | 项目名称 | |
data.refund_unit | false | integer | 退费单位 | |
data.update_by | false | string | 更新人名称 | |
data.update_date | false | string | 更新日期 |
费率列表查询
请求路径
GET /v2/smart-parkinglot/xlink-card/expense-rate/list?data={data}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
data | true | string | data |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
data | false | array | 数据 | |
data.charge_unit | false | integer | 收费单位 | |
data.charge_way | false | integer | 收费方式 | |
data.create_by | false | string | 创建人名称 | |
data.create_date | false | string | 创建日期 | |
data.expense_base | false | integer | 费用基数,单位为分 | |
data.id | false | string | id | |
data.name | false | string | 费率名称 | |
data.parkinglot_id | false | string | 停车场ID | |
data.parkinglot_name | false | string | 停车场名称 | |
data.parkinglot_no | false | string | 停车场编号 | |
data.project_id | false | string | 项目id | |
data.project_name | false | string | 项目名称 | |
data.refund_unit | false | integer | 退费单位 | |
data.update_by | false | string | 更新人名称 | |
data.update_date | false | string | 更新日期 |
获取产权月卡申请时有效日期
请求路径
POST /v2/smart-parkinglot/xlink-card/apply/effective-date
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
card_package_id | true | string | 套餐标识 | |
duration | true | integer | 申请时长 | |
effective_begin_date | true | string | 有效起始日期 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | object | 数据 | |
data.begin_date | true | string | 有效起始时间 | |
data.end_date | true | string | 有效结束时间 |
产权月卡续期
请求路径
POST /v2/smart-parkinglot/xlink-card/month-card/renewal
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
apply_duration | true | integer | 办理时长 | |
apply_mode | true | integer | 申请方式 | |
effective_date_begin | true | string | 有效开始时间 | |
effective_date_end | true | string | 有效结束时间 | |
month_card_id | true | string | 月卡标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | boolean | 数据 |
获取延期时有效日期和应付金额
请求路径
POST /v2/smart-parkinglot/xlink-card/apply/effective-date/charge
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
card_id | true | string | 月卡标识 | |
duration | true | integer | 申请时长 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | object | 数据 | |
data.begin_date | true | string | 有效起始时间 | |
data.bill_payable | true | integer | 应付金额 | |
data.end_date | true | string | 有效结束时间 |
取消月卡申请
请求路径
PUT /v2/smart-parkinglot/xlink-card/apply/cancel/{applyId}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
applyId | true | string | 申请标识 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | boolean | 是否成功 |
29、查询可退费订单
请求路径
GET v2/smart-parkinglot/xlink-payment/card-order
请求参数(需URL编码):
data:
{"limit":999,"offset":0,"query":{"card_id":{"$eq":"856577219739271169"},"payment_status":{"$in":[1]},"end_date":{"$gt":"2021-06-21T16:00:00.000Z"}}}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
card_id | true | string | 月卡id | |
payment_status | true | Int | 订单支付状态 | 固定1 |
end_date | true | Date | 月卡有效期截止时间 |
返回参数
月卡订单集合,同以前
30、查询月卡退费记录
请求路径
GET v2/smart-parkinglot/xlink-card/refund-record
请求参数(需URL编码):
data:
{"limit":999,"offset":0,"query":{"card_id":{"$eq":"856573358328791041"}}}
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
card_id | true | string | 月卡id |
返回参数
字段 | 上层节点 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | body | int | HTTP状态码 | |
code | body | string | 错误码,000000表示请求成功 | |
msg | body | string | 提示内容 | |
data | body | Array | 退费记录对象集合 | |
id | data | string | 退费记录id | |
card_id | data | string | 月卡id | |
return_money | data | string | 退费总金额(>=0) | |
reason | data | string | 退费原因 | |
bank_id | data | string | 银行id | |
bank_name | data | string | 银行名 | |
bank_code | data | string | 银行code | |
bank_owner | data | string | 收款人姓名 | |
bank_code_nbr | data | string | 收款人银行账户 | |
refund_status | data | int | 0:退费中;1:已退费;2:退款失败 | |
result_reason | data | string | 审核原因 | |
task_id | data | string | 四格退费任务id | |
approve_date | data | Date | 审核日期 | |
acct_item_list | data | Array | 退费订单列表集合 | |
acct_item_id | acct_item_list | string | 订单id | |
fee_before | acct_item_list | string | 订单金额 | |
adjust_fee | acct_item_list | string | 退费金额 | |
adjust_desc | acct_item_list | string | 调整说明 | |
eg.
{
"code": "000000",
"msg": "请求成功",
"data": {
"list": [
{
"id": "d3f0b6dc5b5d8239f8985fdcb983f0d7",
"create_date": "2021-06-21T11:14:06.238Z",
"update_date": "2021-06-22T01:33:09.861Z",
"deleted": false,
"create_by": "系统",
"update_by": "系统",
"card_id": "856573358328791041",
"organ_id": "21322160",
"adjust_type_id": "330004",
"return_type": "29",
"return_money": "1",
"reason": "balabala",
"bank_id": "54378",
"bank_name": "广东顺德农村商业银行股份有限公司北窖支行",
"bank_code": "314588000065",
"bank_owner": "易宇琪",
"bank_code_nbr": "6223226037142493",
"operate_user_id": "-1",
"operate_user_name": "-1",
"callback_url": "https://iot-api-uat.smartmideazy.com/v2/smart-parkinglot/xlink-payment/callback/refund",
"refund_status": 1,
"result_reason": "审批通过",
"task_id": "1710015",
"approve_date": "2021-06-22T01:33:09.645Z",
"acct_item_list": [
{
"acct_item_id": "856573358328791040",
"fee_before": "1",
"fee_after": "0",
"adjust_fee": "-1",
"adjust_desc": "balabala"
}
]
}
],
"count": 3
},
"status": 200
}
31、查询银行列表
请求路径
POST v2/smart-parkinglot/xlink-card/refund-record/listBanks
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
bank_name | false | string | 银行名称 | |
bank_code | false | string | 银行编码 | |
page_limit | true | string | 每页显示条数 | |
page_no | true | string | 第几页 | |
eg.
{
"bank_name": "顺德农村商业银行股份有限公司北",
"page_no":"1",
"page_limit":"1000"
}
返回参数
字段 | 上层节点 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | body | int | HTTP状态码 | |
code | body | string | 错误码,000000表示请求成功 | |
msg | body | string | 提示内容 | |
data | body | Array | 退费记录对象集合 | |
count | data | int | 总条数 | |
list | data | Array | 银行对象集合 | |
bank_id | list | string | 银行id | |
bank_code | list | string | 银行code | |
bank_name | list | string | 银行名 |
eg.
{
"code": "000000",
"msg": "请求成功",
"data": {
"list": [
{
"bank_id": "54378",
"bank_code": "314588000065",
"bank_name": "广东顺德农村商业银行股份有限公司北窖支行"
}
],
"count": 1
},
"status": 200
}
32、发起退费申请
请求路径
POST /v2/smart-parkinglot/xlink-card/refund-record
请求参数(需URL编码):
请求参数
字段 | 是否必须 | 字段类型 | 上级节点 | 描述 |
---|---|---|---|---|
card_id | true | string | body | 月卡id |
reason | false | string | body | 退款原因 |
bank_id | true | string | body | 银行id |
bank_code | true | string | body | 银行code |
bank_name | true | string | body | 银行名称 |
bank_owner | true | string | body | 收款人姓名 |
bank_code_nbr | true | string | body | 收款银行账号 |
acct_item_list | true | Array | body | 退款订单信息 |
acct_item_id | true | string | acct_item_list | 订单id |
adjust_fee | true | string | acct_item_list | 退款金额(>=0) |
adjust_desc | false | string | acct_item_list | 调整说明 |
eg:
{
"card_id":"856576981045624833",
"reason":"balabala",
"bank_id": "54378",
"bank_code": "314588000065",
"bank_name": "广东顺德农村商业银行股份有限公司北窖支行",
"bank_owner":"易宇琪",
"bank_code_nbr":"6223226037142493",
"acct_item_list":[
{
"acct_item_id":"856576981045624832",
"adjust_fee":"1",
"adjust_desc":"balabala"
}
]
}
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | true | 退费对象 | 退费对象,详情见报文,字段说明可见“30、查询月卡退费记录” |
eg.
{
"code": "000000",
"msg": "请求成功",
"data": {
"deleted": false,
"card_id": "856576981045624833",
"organ_id": "21322160",
"adjust_type_id": "330004",
"return_type": "29",
"return_money": "1",
"reason": "balabala",
"bank_id": "54378",
"bank_name": "广东顺德农村商业银行股份有限公司北窖支行",
"bank_code": "314588000065",
"bank_owner": "易宇琪",
"bank_code_nbr": "6223226037142493",
"operate_user_id": "-1",
"operate_user_name": "-1",
"callback_url": "https://iot-api-uat.smartmideazy.com/v2/smart-parkinglot/xlink-payment/callback/refund",
"refund_status": 0,
"result_reason": null,
"task_id": "1710021",
"approve_date": null,
"acct_item_list": [
{
"acct_item_id": "856576981045624832",
"fee_before": "1",
"fee_after": "0",
"adjust_fee": "-1",
"adjust_desc": "balabala"
}
]
},
"status": 200
}