微信交通代扣接口

更新时间：2024-11-22 17:35:28

流程介绍:

1.调用1.4用户状态查询api获取当前用户车主状态，如果当前用户车主状态异常（如有欠费(OVERDUE)，未授权(UNAUTHORIZED)，校验授权关系失败(VEHICLE_AUTH_ERROR)），接口同步返回跳转路径(auth_path字段)
，商户侧需根据步骤2引导用户进入车主服务进行相关操作；如果当前用户车主状态正常，不会返回auth_path字段，不需要再引导用户进入车主服务.

2.通过跳转路径(auth_path)调用 ‘用户授权/开通接口api’ 进入车主小程序的对应页面，用户进行授权/开通的操作
H5跳转，通过跳转路径(auth_path)调用 ‘用户授权/开通接口api’ 进入车主H5对应的页面，用户进行授权/开通操作.

3.返回商户H5页面后再次调用用户状态查询api确认用户最新车主状态及车牌信息

4.调用1.1申请扣款接口,微信受理成功.

5.扣款成功,异步返回业务结果,见1.5交易通知

1.1 申请扣款

应用场景:委托代扣可应用于定期扣款或需事后扣款以期提高效率的场景。例如高速，停车场等通过用户授权给商户，进行委托扣款的场景。
注：扣费请求首先按签约协议中记录的优先支付方式扣费，否则从可用扣款方式中依次选择扣款。

  • url:partnerpay/110/payapply
  • Method: POST

请求参数

参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号，当前版本110
pay_type String 3 Y 请求类型，010微信，020 支付宝,当前只支持微信
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号，填写商户系统的订单号
terminal_time String 14 Y 终端交易时间，yyyyMMddHHmmss
sub_appid String 32 Y 微信子商户appid
trade_scene String 16 Y 交易场景 1. PARKING：车场停车场景 2. PARKING SPACE；车位停车场景 3GAS 加油场景 4. HIGHWAY 高速场景 5. BRIDGE 路桥场景
scene_info String 1024 Y 场景信息,格式为json，不同业务场景设置不同的值，具体如后面所列。
plate_number String 32 Y 车牌号
total_fee String 12 Y 金额，单位分
order_body String 128 N 订单描述
goods_tag String 32 N 订单优惠标记，代金券或立减优惠功能的参数
goods_detail String 32 N 订单包含的商品列表信息，Json格式。
attach String 128 N 附加数据,原样返回
notify_url String 128 Y 外部系统通知地址
key_sign String 32 Y 签名字符串,非空参数字典序+令牌，UTF-8编码，32位md5加密转换

当trade_scene场景为：PARKING（车场停车） 时，传如下值
示例值:
{"scene_info":{"start_time":"20170926114339",
"end_time":"20170826114339",
"charging_time":"12312312312",
"plate_number":"CB1000sdfasd",
"free_time":"1200",
"car_type":"大型车",
"parking_name":"欢乐海岸停车场"}
}

参数名称 类型 长度 必填 说明
start_time String 16 Y 入场时间，格式为yyyyMMddHHmmss，该值催缴时会向微信用户进行展示
end_time String 16 N 出场时间
charging_time String 16 Y 计费的时间长。单位为秒
plate_number String 32 Y 车牌号。仅包括省份+车牌，不包括特殊字符
car_type String 16 N 停车车辆的类型，可选值：大型车、小型车
parking_name String 32 Y 停车场名称

当trade_scene场景为：PARKING SPACE 时（车位停车），传如下值

参数名称 类型 长度 必填 说明
start_time String 16 Y 入场时间，格式为yyyyMMddHHmmss，该值催缴时会向微信用户进行展示
end_time String 16 N 出场时间
charging_time String 16 Y 计费的时间长。单位为秒
plate_number String 32 Y 车牌号。仅包括省份+车牌，不包括特殊字符
car_type String 16 N 停车车辆的类型，可选值：大型车、小型车
parking_name String 32 Y 停车场名称
openid String 32 Y 用户标识
space_number String 16 Y 用户停车的车位编号，仅支持英文+数字

当trade_scene场景为：GAS 时（加油），传如下值

参数名称 类型 长度 必填 说明
start_time String 16 Y 入场时间，格式为yyyyMMddHHmmss，该值催缴时会向微信用户进行展示
plate_number String 32 Y 车牌号。仅包括省份+车牌，不包括特殊字符
car_type String 16 N 停车车辆的类型，可选值：大型车、小型车
gas_station String 32 Y 加油站名称
gas_label_name String 8 Y 油品标号名，可选值89、90、92、93、95、97、98、5、0、-10、-20、-35、-50
gas_type String 32 Y 油品类型名称，可选：汽油、柴油
gas_standard String 32 Y 油品标准名称，可选：国V，国IV，粤IV
gas_amount String 16 Y 油品量（单位毫升ml）
gas_gun_no String 16 Y 加油枪号，纯数字

当trade_scene场景为：HIGHWAY 时，传如下值

参数名称 类型 长度 必填 说明
start_time String 16 Y 入场时间，格式为yyyyMMddHHmmss，该值催缴时会向微信用户进行展示
end_time String 16 N 出场时间
plate_number String 32 Y 车牌号。仅包括省份+车牌，不包括特殊字符
car_type String 16 Y 停车车辆的类型，可选值：大型车、小型车
entrance_name String 64 Y 入口站名称
exit_name String 64 Y 出口站名称
carrying_capacity String 8 N 核载人数,纯数字
carrying_range String 32 N 当前车辆核载人数区间，格式数字-数字,6-12
channel_type String 32 Y 高速通道类型，目前可选：ETC、MTC。商户扣费前必须确认当前车牌的标识属性，用户车牌必须具有该通道标识时，才允许扣费。

当trade_scene场景为：BRIDGE 时，传如下值

参数名称 类型 长度 必填 说明
start_time String 16 Y 入场时间，格式为yyyyMMddHHmmss，该值催缴时会向微信用户进行展示
plate_number String 32 Y 车牌号。仅包括省份+车牌，不包括特殊字符
car_type String 16 N 停车车辆的类型，可选值：大型车、小型车
exit_name String 64 Y 出口站名称

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密
result_code String 2 N 业务处理响应码，01成功 02失败
merchant_name String 40 N 商户名称
merchant_no String 15 N Y商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号，商户系统的订单号，扫呗系统原样返回
terminal_time String 14 N 终端交易时间，yyyyMMddHHmmss，全局统一时间格式
total_fee String 12 N 金额，单位分
out_trade_no String 32 N 利楚唯一订单号
attach String 128 N 附加数据,原样返回

1.2 查询订单

  • url:partnerpay/110/queryorder
  • Method: POST

请求参数

参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号，当前版本110
pay_type String 3 Y 请求类型，010微信，020 支付宝,当前只支持微信
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号，填写商户系统的订单号
terminal_time String 14 Y 终端交易时间，yyyyMMddHHmmss
pay_trace String 32 N 当前支付终端流水号，与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间，yyyyMMddHHmmss，全局统一时间格式，与pay_trace同时传递
out_trade_no String 32 Y 订单号，查询凭据，填利楚订单号、微信订单号任意一个
key_sign String 32 Y 签名字符串,非空参数字典序+令牌，UTF-8编码，32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密
result_code String 2 N 业务处理响应码，01成功 02失败
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号，商户系统的订单号，扫呗系统原样返回
terminal_time String 14 N 终端交易时间，yyyyMMddHHmmss，全局统一时间格式
trade_state String 12 N 交易状态SUCCESS—支付成功 ACCEPT—已接收，等待扣款 PAY_FAIL--支付失败 REFUND—转入退款
total_fee String 12 N 金额，单位分
end_time String 12 N 支付完成时间，yyyyMMddHHmmss，全局统一时间格式
out_trade_no String 32 N 利楚唯一订单号
channel_trade_no String 32 N 微信官方订单号
attach String 32 N 附加数据，原样返回

1.3 申请退款

  • url:partnerpay/110/refund
  • Method: POST

请求参数

参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号，当前版本110
pay_type String 3 Y 请求类型，010微信，020 支付宝,当前只支持微信
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号，填写商户系统的订单号
terminal_time String 14 Y 终端交易时间，yyyyMMddHHmmss
pay_trace String 32 N 当前支付终端流水号，与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间，yyyyMMddHHmmss，全局统一时间格式，与pay_trace同时传递
out_trade_no String 32 Y 订单号，查询凭据，填利楚订单号、微信订单号任意一个
refund_fee String 12 Y 退款金额，单位分
key_sign String 32 Y 签名字符串,非空参数字典序+令牌，UTF-8编码，32位md5加密转换

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密
result_code String 2 N 业务处理响应码，01成功 02失败
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
terminal_trace String 32 N 终端流水号，商户系统的订单号，扫呗系统原样返回
terminal_time String 14 N 终端交易时间，yyyyMMddHHmmss，全局统一时间格式
refund_fee String 12 N 退款金额，单位分
end_time String 12 N 支付完成时间，yyyyMMddHHmmss，全局统一时间格式
out_trade_no String 32 N 唯一订单号
out_refund_no String 32 N 唯一退款单号
channel_refund_no String 32 N 微信官方退款订单号

1.4 用户状态查询

应用场景:在停车场、高速、加油等场景下，商户需获取用户车主服务状态/需要关联车主服务。本接口，会查询用户是否开通、授权、有欠费或黑名单用户情况，并将对应的用户状态进行返回。

  • url:partnerpay/110/querystate
  • Method: POST

请求参数

参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号，当前版本110
pay_type String 3 Y 请求类型，010微信，020 支付宝,当前只支持微信
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
sub_appid String 32 Y 微信子商户appid
sub_openid String 32 Y 微信子商户appid下的唯一标识
trade_scene String 16 Y 交易场景 1. PARKING：车场停车场景 2. PARKING SPACE；车位停车场景 3GAS 加油场景 4. HIGHWAY 高速场景 5. BRIDGE 路桥场景
jump_scene String 16 Y APP:通过APP跳转 H5:通过公众号H5跳转(目前仅支持H5跳转)
plate_number String 32 Y 车牌号
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密
result_code String 2 N 业务处理响应码，01成功 02失败
merchant_name String 40 N 商户名称
merchant_no String 15 N 商户号
terminal_id String 8 N 终端号
user_state String 16 N NORMAL：正常用户，已开通车主服务，且已授权访问 PAUSED：已暂停车主服务 OVERDUE: 用户已开通车主服务，但欠费状态。提示用户还款，请跳转到车主服务 UNAUTHORIZED：用户未授权使用当前业务，或未开通车主服务。请跳转到授权接口
auth_url String 1024 N H5授权跳转路径
plate_number_info String 32 N 车牌信息

1.5 交易通知

  • Method: POST

请求参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 Y 业务处理响应码，01成功 02失败
pay_type String 3 Y 请求类型，010微信，020 支付宝
user_id String 40 Y 付款方用户id，“微信openid”、“支付宝账户”
merchant_name String 32 Y 商户名称
merchant_no String 15 Y 商户号
terminal_id String 8 Y 终端号
terminal_trace String 32 Y 终端流水号，商户系统的订单号，扫呗系统原样返回
terminal_time String 14 Y 终端交易时间，yyyyMMddHHmmss，全局统一时间格式
pay_trace String 32 N 当前支付终端流水号，与pay_time同时传递
pay_time String 14 N 当前支付终端交易时间，yyyyMMddHHmmss，全局统一时间格式，与pay_trace同时传递
total_fee String 12 Y 金额，单位分
end_time String 12 Y 支付完成时间，yyyyMMddHHmmss，全局统一时间格式
out_trade_no String 32 Y 利楚唯一订单号
channel_trade_no String 32 Y 微信官方订单号
attach String 32 Y 附加数据，原样返回
key_sign String 32 Y 传参字典序后，拼接令牌(access_token)再MD5加密

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码，01成功 02失败
return_msg String 128 Y 返回信息提示，“签名失败”，“参数格式校验错误"等

© 利楚商服 2020 All rights reserved.