SDK停车收费系统对接协议(车场管理+支付)
停车收费系统对接协议(车场管理+支付)
更新记录
SDK开发包下载
一、系统集成
1.1
1.2车场初始化
1.2.1加密说明
1.2反初始化
1.3http退出登录接口
二、上行接口(收费系统调用SDK)
2.1车辆入场(停车云,泊链)
2.2车辆出场(泊链,停车云)
2.3完整订单记录上传(停车云,订单上传补充接口)
2.4车场收费员信息上传(停车云)
2.5员工上下班记录上传(停车云)
2.6日志上传(停车云)
2.8月卡套餐上传(停车云)
2.9价格上传(停车云)
2.10月卡会员上传(停车云)
2.11异常抬杆上传(停车云)
2.12车辆图片上传(停车云)
2.13月卡续费记录上传(停车云)
2.14通道数据上传停车云
2.15黑名单上传停车云
2.16车型数据上传停车云
2.17手动匹配订单上传停车云
2.18获取二维码地址泊链
2.19车场订单电子支付状态查询接口
2.20查询在场订单
2.21车场交易订单查询(返回h5url)
2.22岗亭交接班记录(泊链)
2.23云平台对账接口
2.24月卡信息查询
2.25储值卡上传(停车云)
2.26储值卡充值记录上传(停车云)
2.27储值卡扣除余额上传(停车云)
2.28储值卡余额查询(停车云)
2.29上传优惠券减免接口
2.30泊链电子支付对账接口
2.31电子发票上传接口
2.32上传收费系统日志
2.33分页查询月卡信息(停车云)
2.34充电减免信息上传(停车云)
2.35内部车上传
2.36平台转发接口
2.37ETC扣款
2.38逃单查询
2.39停车场停车业务纠正
2.40在停业务总数查询
2.41在停业务详情查询
2.42市级车入场判定
2.43获取车道屏幕二维码
离线订单(先走后付)
三、下行接口(SDK回调收费系统)
3.1查询订单价格(泊链)
3.2预付订单通知(泊链)
3.3无牌车入场请求(泊链)
3.4电子收费异步返回结果
3.5价格同步(停车云)
3.6月卡套餐同步(停车云)
3.7月卡会员同步(停车云)
3.8车场收费员信息同步(停车云)
3.9接收消息实现锁车-解锁
3.10月卡续费(泊链)
3.11查询月卡价格(停车云)
3.12优惠券信息同步(停车云)
3.13通道数据下发停车云
3.14黑名单下发停车云
3.15车型数据下发停车云
3.16月卡续费记录下发停车云
3.17手动匹配订单通知(停车云)
3.18抬杆-落杆通知(停车云)
3.19访客管理下发停车云
3.20储值卡同步(停车云)
3.21储值卡余额变更记录下发(停车云)
3.22云平台透传接口
3.23退款下发通知(泊链)
3.24找零支出下发通知(泊链)
3.25平台缴费通知(停车云)
3.27内部车同步(停车云)
3.28手动结算(停车云)
3.29积分电子券信息同步(泊链)
3.31车道监控抓拍下发(停车云)
3.32通知上传收费系统日志(泊链)
3.26查询车场停车位(停车云)
3.33收费系统升级(泊链)
3.34公众号购买月卡查询价格(停车云)
3.35车场有效期下发(停车云)
3.36充电桩充电通知(泊链)
3.37逃单补缴异步返回结果
3.39车辆包月账单信息查询
3.39修改道闸余位
3.40查询月卡车、特殊车
3.41通道识别健康码状态下发
3.42手动入场
3.43车牌校正
3.43固定收费
4.1获取当前车牌余额及是否支持电子支付
4.2获取当前车牌余额及是否支持无感支付(http)
5.1数据定义
5.1.1车型:car_type
5.1.2
5.1.3订单支付类型:pay_type
5.1.4锁车标记:islocked
5.1.5性别:sex
5.1.6操作类型:operate_type
5.1.7员工上下班类型:state
5.1.8数据上传位置:data_target
5.1.9异常抬杆原因:reason
5.1.10是否是泊涟会员:is_exist
5.1.11网络状态:net_status
5.1.12订单支付通道:pay_channel
5.2泊链常见问题答疑
六、专题文档
七、智慧屏应用
7.1获取智慧屏ip
7.2初始化连接智慧屏
7.3推送出场订单
7.4接收被扫数据(SDK回调收费系统)
7.5车场生成出口支付码
7.6推送语音播报
7.7推送进场订单
SUMMARY
文档云
-
+
首页
更新记录
>2022-04-25 1.1接口修改cloud\_addr、cport、bolink\_addr字段示例; 1.2接口修改cloud\_addr、cport字段示例; >2022-04-07 新增2.43获取车道屏幕文字 新增3.39修改道闸余位 新增3.40查询月卡车、特殊车 修改3.7operate\_type字段示例,新增message\_uuid、car\_type、part\_time字段 2.2修改errmsg描述信息,增加福州大脑 2.18新增message\_uuid、data\_target、device\_no字段 3.14新增start\_time、end\_time、message\_uuid字段 3.18新增message\_uuid、event、duration、device\_no字段 3.7新增message\_uuid字段 >2022-03-30 2.2接口修改 is_report、state、errmsg字段描述 3.16接口新增license_color字段 3.18修改channel_name、operate、liftrod_id、channel\_id、operate字段描述,新增order\_id字段。 新增接口2.39停车场停车业务纠正 新增接口2.40在停业务总数查询 新增接口2.41在停业务详情查询 新增接口2.42市级车入场判定 新增接口3.38车辆包月账单信息查询 >2021-09-29 3.11接口新增discount_type字段 3.34接口新增discount、discount_type字段 >2021-09-23 3.12接口新增ticket_type枚举值5:用于下发指定截止时间的全免券,同时下发 time_range为时间戳即全免券的截止时间(精确到秒) >2021-08-24 2.1新增is_report字段 2.2新增is_report字段 3.1新增返回字段 is\_report、empty\_plot >2021-08-13 3.1新增pay_user_id字段 3.2新增pay_user_id字段 3.3新增pay_user_id字段 3.4新增pay_user_id字段 >2021-07-21 增加逃单补缴异步返回结果接口3.37 >2021-07-03 2.1增加数组字段escapeOrder 3.1增加参数isEscape 增加逃单查询接口2.38 >2021-07-02 2.26、3.21接口加参数actual_money >2021-06-29 2.14、3.13加参数lane_no 新增2.37接口 支持ETC扣费 2021-02-07 1、新增7.6 推送语音播报接口; 2、7.3 推送订单接口新增语音字段 tts,下发带有该字段,可播报包含的内容 >2021-02-04 2.2,2.3接口:新增 etc_pay字段,用于显示订单的etc支付的金额 本地上传到云后,在云的订单详情可查看 >2021-02-01 1.1初始化接口扩展参数新增字段prepay_query可控制SDK是否接收预付查询消息;prepay_query值为0时该SDK不接收预付查询消息,其他设置不生效; > 2021-01-25 > 3.12接口返回 新增字段 intime、order_id:可限制用券的张数。 > 由于无在场订单,所以在后台设置的用券限制 对无在场订单的用券张数没有限制,若车场想限制没有在场订单 与 有在场订单的用券张数一致,则需要在下发用券have_order为0时,返回intime 、order_id、car_number 这三个字段。 > 2021-01-18 >3.27接口,下发时增加字段create_time,之前的数据不下发该字段,接口上线后生效。 > 2021-01-05 > 2.1接口加car_cost_type字段,若上传此字段且有值,则云平台的在场订单、订单记录中可以显示该车牌的车辆种类。 > 2020-12-25 > 接口3.12 接口下发字段 加 pay_limit, 支付公司限制,使用该功能时车场需开通农行支付通道,计费系统对此类优惠券做相应的减免 > 2020-12-09 > 接口3.28接口下发字段 加 remark字段,显示车场手动结算时的备注信息 > > 2020-10-30 > 接口 2.10、3.7 新增字段group_id月卡分组编号 > 2020-10-27 > 接口 3.25新增字段 type 缴费数据类型:1、充电订单;2、积分抵扣订单 > 2020-09-27 > 新增2.36平台转发接口 > 2020-09-25 > 3.12用券接口 下发时 ticket_type 加类型4 外部优惠券,返回时也加 ticket_type > 2020-09-22 > 新增2.35内部车上传接口 > 3.21接口新增 account_type 流水类型 字段 > 2020-09-04 > 3.19 访客下发接口新增字段attributes,访客预约申请的车场自定义输入项,最多支持5项 > 2020-09-01 > 2.11接口 增加operate字段,当落杆操作时,必传 > 2020-08-18 > 1、3.25 下发接口新增充电桩相关字段 > 2、新增上行接口 2.34 充电减免信息上传,该信息展示在车场后台的抵扣记录列表 > 2020-08-17 > 3.11 月卡查询价格接口新增下行字段 discount, 套餐折扣额度,在车场后台设置套餐的不同缴费周期对应的缴费优惠折扣额度 > 2020-08-11 > 月卡上传接口 2.10 新增字段 force_update,是否强力删除云平台重复车牌号的会员: > 本地上传会员时,赋值该字段为1 ,则删除云端相同车牌号的月卡记录,只保留此次上传的记录。(该强删操作不会同步到本地系统) >2020-05-13 3.21接口下发储值卡续费记录时:新增非必传字段collector 收费员、user_id用户编号,云端续费储值卡时,在储值卡续费记录中显示收费员 2.26接口上传储值卡续费记录时:新增非必传字段user_id用户编号,车场可上传储值卡续费记录对应的收费员 >2020-04-09 访客管理接口3.19新增访客二维码类型字段type 、通道编号channel_id >2020-03-18 > 1、新加云平台下发接口3.35,厂商修改车场的有效期,下发该值给本地系统,本地自行处理相关业务 > 2、3.12优惠券信息同步接口增加下发字段shop_id 商户编号 >2020-01-17 >3.12优惠券信息同步接口新加字段 buy_money,车主买券支付金额,使用固定码且设置车主支付的优惠券下发时必传 > 2019-12-27--V 2.3.3.1 > 接口3.25 新增字段: > duration,减免时长(分钟)、start_charging_time,充电开始时间、stop_charging_time,充电结束时间 > 2019-12-13 --V2.3.3.1 > 接口2.2、2.3新增derate_duration字段,表示减免时长,车场本地上传后,可在云平台的订单详情页查看 > 2019-12-07--V2.3.3.1 > 接口3.12 优惠券信息同步 新增固定码优惠券生效时间段字段,使用固定码时会下发给车场,车场根据该值判断具体时间段内给订单做减免优惠;同时扫固定码领券时会下发该固定码的名称 > 2019-12-04--V2.3.3.1 > 接口3.11公众号月卡续费查询价格接口新加返回字段cloud_notice,公众号月卡续费通知模式 > cloud_notice: > 返回1,由云平台下发月卡续费通知(接口3.16)并对该月卡会员进行延期操作,本地收到接口3.16的通知后只延期本地月卡会员记录即可; > 返回0,按老模式由泊链下发续费通知(接口3.10),本地收到接口3.10的通知后需延期本地月卡会员记录,并上传该续费记录和该月卡会员的有效期更新记录到云平台。 > 2019-11-22--V2.3.3.1 > 储值卡支持选择云端车场已有车型的功能,接口2.25、3.20新增车型相关字段 > 2019-10-29--V2.3.3.1 > 3.11月卡查询价格接口新加下发字段period,套餐的缴费周期,默认 月,与套餐的该字段值对应,当套餐的period 值为“年”时,下发的months 值 1 表示 1年,车场按该字段判断应返回的价格; > 3.10 接口的months 字段仍表示 月数不变。 > 2019-10-15--V2.3.3.1 > 1、3.1查询订单价格接口:增加下发字段licence无牌车车牌 > 2019-10-11--V2.3.3.1 > 1、新增接口2.33 分页查询月卡信息(停车云),用于本地查询云端的大量月卡数据 > 2019-09-26--V2.3.3.0 1、新增接口3.34 公众号新建月卡查询价格接口,用于私有公众号的高级需求 > 2019-08-21--V2.3.3.0 1、http对接车场支持使用公有云平台的优惠券业务,需要初始化时加扩展参数,详情见1.1初始化接口; 2、接口3.12下发优惠券支持http对接车场,由于目前订单不支持上传到云平台,所以下发的have_order=0,需本地按文档返回订单信息; > 2019-08-17--V2.3.3.0 1、云平台注册月卡支持选择通行通道,涉及接口 2.10 和接口 3.7; > 2019-08-12--V2.3.3.0 1、新增接口2.32上传收费系统日志; 2、新增接口3.32通知上传收费系统日志; 3、新增接口3.33 下发收费系统升级通知。 > 2019-08-02--V2.3.3.0 > 1、接口2.12 新增上传字段:uuid,车道监控抓拍的唯一编号 > 2、接口2.12 picture_source 图片来源新增:capture,上传车道监控抓拍图片 > 3、接口3.18 新增下发字段:liftrod_id,此次抬杆编号,车场原值返回 > 4、新增下行接口 3.31,车道监控抓拍下发(停车云) > 2019-07-31--V2.3.3.0 > 1、接口3.1 查询价格返回参数新增discount_info,本地积分电子券,已对接的车场可返回该字段 > 2、新加接口3.30 积分电子券信息同步(泊链),积分电子券信息下发到车场SDK。 > 2019-06-19--V2.3.2.0 > 3.16月卡续费下发接口新增end_time 结束时间 > 2019-06-12--V2.3.2.0 > 新增 2.30 泊链电子支付对账接口,需使用**2.2.2.0及以上版本 SDK** > 2019-05-27--V2.3.2.0 > 接口2.4收费员信息上传接口的返回结果,新加字段 :cloud_id,云端登录账号 > 2019-05-20--V2.3.2.0 > 接口3.10月卡续费、3.11月卡查询接口新增下发字段:car_number,车牌号 > > 2019-04-22--V2.3.2.0 新增接口3.27内部车下发,由云平台注册下发给车场 > 2019-03-29--V2.3.1.0 接口3.2新加预付类型prepay_type枚举值3,现金预付 > 2019-03-26--V2.3.1.0 > 接口2.24月卡查询接口新增返回字段: b_time,月卡开始时间;e_time ,月卡结束时间;mobile车主电话 > 2019-03-20--V2.3.1.0 > 1、新增云平台透传接口 > 3.25平台缴费通知、3.26 查询停车场停车位通知 > 2019-02-20--V2.3.1.0 > 1、新增接口2.29 上传优惠券减免接口(云平台页面暂不支持) > 2、新增接口3.23 退款下发通知 > 3、新增接口3.24 找零支出下发通知 > 4、接口3.2、3.4 添加下发字段: > arrive_money,到账金额;account_type,到账类型(1-收入 0-支出) ;fee,手续费;remark,说明(接口上传过来的title返回下去) > 5、接口3.10添加下发字段: > out_trade_no,交易流水号(外部传递上来的);arrive_money,到账金额;account_type,到账类型(1-收入 0-支出) ;fee,手续费;remark,说明(接口上传过来的title返回下去) > 2019-01-15--V2.2.1.0 > 1、新增3.22 云平台透传接口 > 2019-01-11--V2.2.1.0 1、云平台优惠券下发接口3.12新增折扣券类型ticket_type 3,discount 折扣券额度 > 2018-12-10--V2.2.1.0 1、云平台新增储值卡相关上行接口2.25、2.26、2.27、2.28 2、云平台新增储值卡相关下行接口3.20、3.21 > 2018-12-08--V2.2.0.0 1、接口3.12的增加下行参数starttime,券可用开始时间;endtime,券可用结束时间;startdate,券可用开始日期;enddate,券可用结束日期 > 2018-12-05--V2.2.0.0 1、接口2.13的返回参数增加原值返回的字段trade_no 2、新增接口2.24 月卡信息查询 > 2018-09-26--V2.2.0.0 > 1、接口2.1新增非必填字段force_update,是否强力删除重复订单号的订单,1 强删,0 不强删;强删后,该订单号之前的订单会被此次上传的订单覆盖,影响之前的订单记录、统计分析; > #### (需使用**SDK2.2.2.0及以上版本**安装包) > 2、新增接口2.23 云平台对账接口,本地收费系统调用该接口,可以查询一段时间内的订单详情(不超过24小时); > #### (需使用**SDK2.2.2.0及以上版本**安装包) > 3、云平台所有的上行接口的返回信息增加字段park_id,车场编号; > 4、云平台所有的下行接口增加字段park_id,车场编号。 >2018-09-26--V2.1.0.2 >1、接口3.1,查询订单价格,当车场未成功上传入场订单到泊链时,返回值加上in_time 和 car_number,也可预付该订单。 2、接口3.12,优惠券信息下发增加字段have_order,云平台是否有对应车牌的在场订单。have_order为 0 时,云平台没有在场订单,车场本地可以根据该字段进行业务处理,如果需要减免本地未上传的订单,原路返回have_order,同时返回car_number进行减免、记录。 > ## **3、注:当 have_order 下发为 0 时,如果车场不做处理直接返回 state 1,order_id 原值返回空字符串,则该券不被使用,等待第二天凌晨 1 点回收,提示无在场订单。** >2018-08-20--V2.1.0.2 >接口2.12,图片来源picture_source为order时,图片上传位置data_target可以为bolink >2018-08-01--V2.1.0.2 >接口3.12新增字段 time_range,如果一张全免券支持多次使用,该字段为这张全免券可以减免的有效时长。此时有值。其它时候为0 > 2018-07-31--V2.1.0.2 > 新增接口 2.22 岗亭交接班记录(泊链) > 2018-07-09--V2.1.0.2 > 修改接口5.1.12支付通道枚举值增加,5 银盛 > 2018-07-05--V2.1.0.2 > 修改接口5.1.12支付通道枚举值增加,4 建行 > 2018-06-28--V2.1.0.2 > 修改接口3.2、 3.4返回字段增加pay_time支付时间 > 2018-06-19--V2.1.0.0 > 新增接口3.19,云平台访客管理下发接口 >2018-06-06--V2.1.0.0 >新增接口2.20,查询在场订单接口 >2018-05-21--V2.1.0.0 >初始化接口扩展参数新增字段receive_cloud,接收云平台下行消息,0不接收,默认1接收 >2018-05-08--V1.1.8 >修改接口2.13,增加字段start_time ,开始时间,上传后可在云平台显示 >2018-04-26--V1.1.8 >新增接口1.3 http退出登录接口 >2018-03-29--V1.1.8 >修改接口2.18,增加字段change >2018-03-28--V1.1.8 >修改接口3.1,增加字段in_time, car_number,hide_time_info > 2018-03-15--V1.1.8 新增接口2.19车场订单电子支付状态查询接口 >2018-03-05--V1.1.8 接口3.12增加下发字段shop_name,商户名称 >2018-03-01--V1.1.8 接口3.1返回字段derate_money,减免金额(元)类型改为String类型 >2018-01-04--V1.1.8 1、增加了接口1.2反初始化 2、接口3.7、3.12增加字段pay_channel支付通道 3、接口1.1,3.6,3.7,3.11,3.12的http对接部分增加字段 >2018-01-02--V1.1.8 1、接口2.18增加返回字段channel_id和type >2017-12-26--V1.1.8 1、接口2.18、3.11增加http对接方式字段信息 2、接口3.6、3.7、3.12返回字段data_target,修改说明为传输位置,SDK模式必传,HTTP模式不传 > 2017-12-18--V1.1.8 1、新增车场http对接模式;新增接口2.1.1更新用户余额(http模式) 2、新增接口2.18获取二维码地址(泊链) 3、接口3.10增加字段ticket_unit,时长券单位;字段ticket_type增加枚举值2,全免券 > 2017-12-12--V1.1.7 接口3.3增加返回字段card_id_local,本地月卡编号,上传会覆盖card_id编号 > 2017-11-28--V1.1.7 接口4.1增加字段autopay是否免密支付 > 2017-11-24--V1.1.7 1、新增上行接口2.14通道数据上传、2.15黑名单上传、2.16车型数据上传 2、新增下行接口3.13通道数据下发、3.14黑名单下发、3.15车型数据下发、3.16月卡续费记录下发 3、接口1.1增加字段set_params,扩展参数 4、接口2.3、2.4、2.5、2.6、2.8、2.9、2.11、2.12增加返回字段; 5、接口2.10、2.13增加上行、返回字段 6、接口3.2增加字段car_type车辆类型、period缴费周期、price月卡价格 7、接口3.3增加字段p_lot车位、remark备注、tel电话、limit_day_type单双日限行、car_type_id车辆类型 8、接口3.6增加返回字段position,停车位置 > 2017-11-20--V1.1.6 1、接口3.12增加非必填字段total,支付金额 > 2017-10-19--V1.1.6 1、接口2.12字段picture_source增加:上传手动匹配订单图片时值为:confirm 2、接口2.12增加字段event_id,模糊匹配事件编号 3、增加接口2.17 手动匹配订单上传 4、增加接口3.17 手动匹配订单通知、接口3.18 抬杆/落杆通知 > 2017-09-18--V1.1.6 1、接口3.7增加非必填字段prepay_type,预付类型 > 2017-08-30--V1.1.5 1、修改初始化接口中的local_id描述信息,可包含通道信息 2、接口3.11增加时间戳字段timetemp > 2017-08-15--V1.1.5 1、接口3.12增加字段出口通道out_channel_id > 2017-08-07--V1.1.4 1、增加接口3.11无牌车入场请求(泊链)、接口3.12电子收费异步返回结果 2、接口3.6增加字段支付场景pay_scene、出口通道out_channel_id、查询价格编号query_order_no 3、接口3.7增加字段查询价格编号query_order_no 4、接口2.1、接口2.2、接口2.3的字段岗亭/工作站唯一标识worksite_id改为work_station_uuid > 2017-07-13--V1.1.4 1、接口2.10、接口3.3的字段price说明改为:实收金额 2、接口2.10、接口3.3增加字段amount_receivable,说明:应收金额 > 2017-07-12--V1.1.4 1、接口2.2、2.3的字段total说明改为:实时订单金额(不包含已预付、已减免的部分);接口3.6不做修改 2、接口2.7的字段operate_user改为user_id,说明为:收费员编号;state为必传;字段type改为ticket_type 3、接口2.13、3.3字段card_id说明为:月卡会员记录编号 4、接口3.2字段card_id改为package_id,月卡套餐编号 > 2017-07-08--V1.1.3 1、接口3.9的buy_month字段名修改为months,字段类型修由String改为Number;开始时间start_time字段类型由String修改为Number 2、接口3.3的车牌car_number,多个车牌用“,”英文分隔 > 2017-07-07--V1.1.3 1、接口2.10的车牌car_number,多个车牌用“,”英文分隔 2、接口3.6返回字段增加订单金额total > 2017-07-05--V1.1.3 1、添加优惠券下发接口3.10 2、3.6接口增加返回值减免时长derate_duration和减免金额derate_money 3、接口2.1、2.3、2.5、2.6、2.7、2.8、2.11、2.12、2.13增加同步方法返回 4、接口2.3删除user_type字段 5、修改接口2.4、2.9、2.10、4.1返回信息 6、修改接口3.5字段信息 7、接口3.7增加字段订单流水号trade_no和查询价格时间query_time 8、接口3.8增加字段车场编号comid和收费系统编号local_id,修改字段months和start_time类型 > 2017-08-10--V1.1.3 1、修改接口2.12字段信息增加HTTP 对接模式,上传图片到泊链,post请求
admin
2023年9月13日 17:50
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码