开始开发
信息查询
系统对接
版本号变更查询
银行转账
门禁考勤
第三方信息导入
第三方应用支付消费接口
第三方H5对接
- 获取H5链接地址
信息变更
信息校验
- 校验该房间在主平台是否存在引用
交易冲正
- 冲正
- 订单冲正补账
支付消费
其他
- 商户营业汇总查询
个性化接口

一卡通Api接口

开始开发

注意事项

接口文档增加了接口版本号（Version），标注接口是自哪个版本起新增的。
开发者在开发时，请注意接口里的接口版本号（Version），现场一卡通程序版本大于此版本号时接口才有效。开发过程中，务必联系现场人员确认一卡通程序版本号。

场景描述

一些简单场景的对接，请参考文档链接：一卡通API相关业务场景流程图

开发者规范

开发者进行一卡通平台对接开发时，除了需要满足每个接口的规范限制外，还需特别注意用户数据等敏感信息的使用规范。
涉及用户数据时：

您的服务需要收集用户任何数据的，必须事先获得用户的明确同意，且仅应当收集为运营及功能实现目的而必要的用户数据，同时应当告知用户相关数据收集的目的、范围及使用方式等，保障用户知情权。
您收集用户的数据后，必须采取必要的保护措施，防止用户数据被盗、泄漏等。
您在一卡通平台中收集的用户数据仅可以在该一卡通平台中使用，不得将其使用在一卡通平台之外或为其他任何目的进行使用，也不得以任何方式将其提供给他人。
如果认为您收集、使用用户数据的方式，可能损害用户体验，正元智慧有权要求您删除相关数据并不得再以该方式收集、使用用户数据。
一旦您停止使用本服务，基于任何原因终止您使用本服务，您必须立即删除全部因使用本服务而获得的数据（包括各种备份），且不得再以任何方式进行使用。

术语与约定

一卡通平台对接开发时，定义了相关术语与约定。

一、术语

账号：一卡通系统账号，标识指定账户。
卡账号：一卡通系统卡账号，标识指定卡片。
人员编号：一卡通系统人员编号，一般指的是校园卡号或企业职工号。
电子账户钱包：电子账户钱包是账户的联网交易钱包，也称为“库钱包”。
电子现金钱包：电子现金钱包是卡片上的交易钱包，也称为“卡钱包”。

二、约定

1.约定返回的json字符串以全字符串("string":"string")的形式；

2.在返回的json字符串中，"data"键中存储的数据是无序排列的。文档中为了方便开发者阅读，所以按一定规则进行了排序；

3.一卡通系统对返回数据字段做了限制，第三方只能取得限制范围内的数据字段。
针对"data"键中存储的数据，注意：
    返回数据字段“是否必填”为“否”时，指的是该字段对应键值对可以不返回。
    返回数据字段“是否可为空字符串”为“是”时，指的是该字段对应键值对的值可以为空字符串。
    如 birthday“是否必填”为“否”，“是否可为空字符串”为“是”，那么返回json数据可能出现以下几种情况：

{
    "code":"0",
    "msg":"请求成功",
    "data":{
        "accNum":"2",
        "accName":"24",
        "sign":"dd68f70aeb8a166f78dea9c275f3a466"
    }
}
或者
{
    "code":"0",
    "msg":"请求成功",
    "data":{
        "accNum":"2",
        "accName":"24",
        "birthday":"",
        "sign":"dd68f70aeb8a166f78dea9c275f3a466"
    }
}

接口返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。
全局返回码说明如下：

返回码	说明
-1	系统繁忙，具体看错误消息
0	请求成功
1	签名无效
2	多种验证错误，具体看错误消息
10001	系统权限认证服务错误
10002	系统签名服务错误
10003	应用服务错误
30000	无效参数，具体看错误消息
30001	缺少签名参数
30002	缺少start或end参数
40001	appId无效
40002	appSecret错误
40003	数据加密认证失败!
40004	无效的access_token!
40005	未经一卡通平台授权!
41001	账户不存在
41002	卡片不存在
41003	默认主卡不存在
41004	钱包不存在
41005	默认钱包不存在
41006	交易流水不存在
41007	帐号和卡帐号不匹配
41008	密码不正确
41009	订单不存在
41010	卡片未被禁止销卡，不能进行解除操作
41011	卡片已禁止销卡，不能进行禁止操作

数据字典

接口返回的各类编号对应的名称
账户状态(accStatus)：

编号	名称
-2	申请开户
-1	预开户
0	销户
1	有效
3	冻结
4	预销户
98	冻结充值
99	失效（过有效期）

人员类别(accType)：

编号	名称
1	学生
2	教工
3	其他人员
4	临时人员

卡片状态(cardStatus)：

编号	名称
0	销卡
1	有效
2	挂失
3	冻结
4	预销卡
5	锁卡

证件类型(idType)：

编号	名称
1	身份证
2	护照
3	学生证
4	工作证
5	军官证
6	其他证件
7	台胞证

主副卡(mainOrVice)：

编号	名称
1	主卡
2	副卡

性别(sex)：

编号	名称
0	未知
1	男
2	女
9	未说明

交易状态(transferStatus)：

编号	名称
1	待操作
2	操作中
3	操作成功
4	操作失败

交易大类(transferType)：

编号	名称
1	操作类
2	消费类
3	充值类
4	补助类

一卡通交易流水状态(recFlag)：

编号	名称
0	无效流水
1	有效流水
2	TAC验证失败
3	开环流水
4	重帐流水
5	灰交易
6	库余额不合法
7	异常流水

渠道类型(compareType)：

编号	名称
0	无
1	支付宝
2	微信
3	iPay88
4	翼支付
5	E路通
6	银联
7	龙支付
8	和包
9	校园卡
10	云马
11	微校
12	威富通
13	农业银行

交易类型(feeNum)：

编号	名称
38	存款管理费
42	消费管理费
100	就餐（商务消费）

操作类型（transType）:

编号	名称
0	其他
1	操作类
2	消费类
3	充值类
4	消费充值
5	缴费充值
6	消费类对账
7	充值类对账
8	消费充值对账
9	缴费充值对账
10	配卡充值
11	配卡充值对账
12	自助开卡

获取access token

access_token是一卡通平台的全局唯一票据，一卡通平台调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token有失效时间，需定时刷新，重复获取将导致上次获取的access_token失效。
公众平台的API调用所需的access_token的使用及生成方式说明：

1、为了保密appsecrect，第三方需要一个access_token获取和刷新的中控（中间控制）服务器。而其他业务逻辑服务器所使用的access_token均来自于该中控服务器，不应该各自去刷新，否则会造成access_token覆盖而影响业务；
2、目前access_token的有效期通过返回的expire_in来传达，目前是7200秒之内的值，其中expire_in=0表示不失效。中控服务器需要根据这个有效时间提前去刷新新access_token。在刷新过程中，中控服务器对外输出的依然是老access_token，此时公众平台后台会保证在刷新短时间内，新老access_token都可用，这保证了第三方业务的平滑过渡；
3、access_token的有效时间可能会在未来有调整，所以中控服务器不仅需要内部定时主动刷新，还需要提供被动刷新access_token的接口，这样便于业务服务器在API调用获知access_token已超时的情况下，可以触发access_token的刷新流程。

如果第三方不使用中控服务器，而是选择各个业务逻辑点各自去刷新access_token，那么就可能会产生冲突，导致服务不稳定。
如果第三方应用存在多个业务逻辑点，这里列出几个可选方案如下：

方案1：第三方有条件提供中控服务器。一卡通系统分配一套appid和appsecret给第三方，第三方在中控服务器统一获取和刷新access_token，第三方应用的各个业务逻辑点所使用的access_token均来自于该中控服务器。
方案2：第三方没有条件提供中控服务器。一卡通系统分配多套appid和appsecret给第三方（默认商户相同），第三方在各个业务逻辑点分别配置appid和appsecret（一个业务逻辑点一套）。

一卡通平台可以使用AppID和AppSecret调用本接口来获取access_token。APPID和APPSECRET可在一卡通平台相应管理人员获取。
接口调用请求说明

http请求方式: GET
URL/api/token?appid=APPID&appsecret=APPSECRET

参数说明

参数	是否必须	说明
appid	是	第三方用户唯一凭证
appsecret	是	第三方用户唯一凭证密钥

返回说明
正常情况下，一卡通平台会返回下述JSON数据包：

{access_token":"ACCESS_TOKEN","expires_in":7200}

参数	说明
access_token	获取到的凭证
expires_in	凭证有效时间，单位：秒

错误时一卡通平台会返回错误码等信息，JSON数据包示例如下（该示例为appId无效）:

{"code":"40001","msg":"appId无效"}

签名指南

签名算法
签名生成的通用步骤如下：
第一步，设所有发送或者接收到的数据为集合M，将集合M内的参数按照参数名ASCII码从小到大排序（字典序），拼接成字符串stringA。
特别注意以下重要规则：

参数名ASCII码从小到大排序（字典序）；
如果参数不传则不参与签名；
参数名区分大小写；
调用一卡通接口时，sign参数由其他请求参数计算得到，sign参数本身不参与签名。

请求数据签名
举例：假设传送的参数如下

http请求方式: POST（请使用http协议）
URL为指定服务商提供的地址
http://127.0.0.1:8080/easytong_app/api/payservice/recharge?access_token=ACCESS_TOKEN
POST数据格式：application/x-www-form-urlencoded
POST数据例子：
	 "accNum"："2",
	 "amount":"100.00",
	 "cardAccNum":"2",
	 "eWalletId":"1",
	 "liquidationDate":"20170101",
	 "serialNum":"29199388433"，
	 "sourceChannel":"1",
	 "sign":"322C77067A392E9A8960CDEBCE147B5E"

第一步：对参数按照key=value的格式，并按照参数名ASCII字典序排序。

正例（按照参数名ASCII字典序排序）：
stringA="accNum=2&amount=100.00&cardAccNum=2&eWalletId=1&liquidationDate=20170101&serialNum=29199388433&sourceChannel=1";

反例（没有按照参数名ASCII字典序排序）：
stringA="serialNum=29199388433&sourceChannel=1&accNum=2&amount=100.00&cardAccNum=2&eWalletId=1&liquidationDate=20170101";

第二步：拼接appid密钥。注意：key=appid 不参与ASCII字典序排序，直接拼接到字符串尾部。

stringSignTemp="stringA&key=appid";
假设appid=123456,那么根据以上例子计算得到的签名为：
sign=MD5(stringSignTemp).toUpperCase()="322C77067A392E9A8960CDEBCE147B5E";

第三步：sign赋值

响应数据签名
举例：假设返回的参数如下

{
	"code":0,
	"msg":"ok",
	"data":{
		"accName":"张三",
		"accNum":"2",
		"amount":"100.00",
		"liquidationDate":"2017-01-01",
		"perCode":"5464564",
		"platformSerialNum":"5456464236",
		"serialNum":"29199388433",
		"sign":"7A7EF725B629C7B4648DED784D522DDB"
	}
}

第一步：对data数据进行解析，对参数按照key=value的格式，并按照参数名ASCII字典序排序。

正例（按照参数名ASCII字典序排序）：
stringA="accName=张三&accNum=2&amount=100.00&liquidationDate=2017-01-01&perCode=5464564&platformSerialNum=5456464236&serialNum=29199388433";

反例（没有按照参数名ASCII字典序排序）：
stringA="perCode=5464564&platformSerialNum=5456464236&accName=张三&accNum=2&amount=100.00&liquidationDate=2017-01-01&serialNum=29199388433";

第二步：拼接appid密钥。注意：key=appid 不参与ASCII字典序排序，直接拼接到字符串尾部。

stringSignTemp="stringA&key=appid";
假设appid=123456,那么根据以上例子计算得到的签名为：
sign=MD5(stringSignTemp).toUpperCase()="7A7EF725B629C7B4648DED784D522DDB"

第三步：sign赋值

加解密

方式一

使用3des算法，加密模式：CBC，填充：pkcs5padding

//加密(对明文进行加密以base64输出(其中字符集均采用UTF-8编码))：
  var buff = getBytes(明文,'utf-8');
  var 密文 = Base64Encoder(encrypt(buff,keys,iv))
//解密(对密文进行base64解码，在进行解密，获取 UTF-8 字符串)：
  var buff = Base64Decoder(密文);
  var 明文 = toString(decrypt(buff,keys,iv),'utf-8');
// 例：
key='abcdefgh12345678abcdefgh';
iv='12345678';
明文='api';
密文='eH89ioIVp/Y='

信息查询

门禁流水查询(个性化新增个人编号查询)

基本信息

Version： ZYTK40_40.20.0731,ET_v5.1.20.0731,ET_v5.1.23.1231

Path： /api/common/infoqueryservice/queryacceventrecord?access_token={access_token}_1710929501709

Method： POST

接口描述：

40.21.1231之前不支持门禁机流水查询，只支持考勤机和考勤一体机
ET5.1.23.1231增加deviceNum，doorNum字段

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	否	1	账号
perCode	text	否	testUser	个人编号(账号为空时才生效，若账号不为空，该参数无效)
optNum	text	否	1001	操作员编号，接易通必须传
start	text	是	1	从第几条开始
limit	text	是	20	每页限制几条
startTime	text	是	2019-01-01 12:12:12	查询起期
endTime	text	是	2019-01-01 12:12:12	查询止期
inOrOut	text	否	1	进出门方向 1-进 2-出（易通）
enterType	text	否	1	进门方式，0-刷卡（默认） 1-刷脸 2-虹膜 3-指纹 4-扫码（易通）
eventIds	text	否	1,2	门禁事件编号多个以英文逗号","分隔
clsNum	text	否	1	卡户身份编号
accDepts	text	否	1,2,3	账户部门范围，多个账户部门编号以英文逗号","分隔
deviceNums	text	否	756,856	平台门禁机设备的设备编号，多个设备编号以英文逗号","分隔（易通）
doorNums	text	否	1,2,3	门编号，多个以英文逗号","分隔
orderType	text	否	0	0-升序，1-降序，不传，默认升序
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须
├─ count	string	必须	总条数
├─ list	object	必须
├─ recId	string	必须	事件记录号
├─ cardSID	string	必须	卡号
├─ accNum	string	必须	帐号
├─ accName	string	必须	姓名
├─ accDepFullPath	string	非必须	部门全路径
├─ percode	string	必须	个人编号
├─ ocurrDateTime	string	必须	事件发生时间
├─ deviceNum	string	非必须	设备编号(ET5.1.23.1231增加)
├─ deviceName	string	非必须	设备名称
├─ doorNum	string	非必须	门编号(ET5.1.23.1231增加)
├─ doorName	string	非必须	门名称
├─ enterTypeName	string	非必须	进门方式名称
├─ deviceSN	string	非必须	设备序列号
├─ enterType	string	非必须	事件触发类别 0-刷卡，1-人脸，2-虹膜，3-指纹 4-二维码（40 0-刷卡，1-人脸，2-二维码，3-指纹）
├─ eventName	string	非必须	触发事件名称
├─ inOrOutName	string	非必须	进出方向（40不支持）

查询免密签约状态

基本信息

Version：

Path： /api/common/queryWithholding

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
sign	text	是	签名
accNum	text	是	账号
payType	text	是	签约渠道,000001(支付宝)

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ status	string	必须	//代扣签约状态，0未签约，1已签约，2已解约

根据到账时间查询交易流水

基本信息

Version： ET_v5.1.22.0615

Path： /api/common/infoqueryservice/querytransactionbyuploadtime?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	是	1
start	text	是	1
limit	text	是	20
uploadTimeStart	text	是	2022-03-09 00:00:00
uploadTimeEnd	text	是	2022-04-09 00:00:00
accNum	text	是	3601
categoryId	text	是	1	1-操作类，2-消费类，3-充值类，4-补助类
sign	text	是		签名

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须	返回码
data	object	非必须
├─ count	number	非必须	流水总数
├─ sign	string	非必须	签名
├─ list	object []	非必须		item 类型: object
├─ accName	string	非必须	姓名
├─ accNum	string	非必须	账号
├─ cardAccNum	string	非必须	卡账号
├─ categoryId	string	非必须	交易大类编号
├─ dealTime	string	非必须	交易时间
├─ feeName	string	非必须	交易小类名称
├─ feeNum	string	非必须	交易小类编号
├─ isRed	string	非必须	是否冲正（0：否 1：是）
├─ monDb	string	非必须	库余额
├─ monDeal	string	非必须	交易金额
├─ monDiscount	string	非必须	优惠金额
├─ payEpid	string	非必须	使用单位号
├─ perCode	string	非必须	个人编号
├─ recFlag	string	非必须	流水标记
├─ recNum	string	非必须	流水号
├─ redFlag	string	非必须	冲正标记（0：未被冲正 1：被冲正）（原单的redflag改为1）
├─ uploadTime	string	非必须	到账时间
├─ proofNum	string	非必须	第三方流水号
msg	string	非必须	返回消息

查询允许交易的使用单位

基本信息

Version： ET_v5.1.20.1130

Path： /api/common/infoqueryservice/getallowtransepids

Method： POST

接口描述：

查询跨单位交易的情况下，允许交易的使用单位

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	29211	易通帐号
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须	签名
├─ list	object	必须
├─ allowTransEpId	string	必须	允许交易的使用单位编号
├─ epIdName	string	必须	使用单位名称

订单查询

基本信息

Version： v5.1.20.0115,ET_v5.1.20.0531,ZYTK40_40.20.0331

Path： /api/common/payservice/orderquery?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定订单进行订单信息查询操作，该接口需要权限认证。
0731增加到账时间

当queryType = 1时，只能查询时间范围在一年内的订单，如，发起时间2023.12.12 10:48:00, 时间范围为 2022.12.13 00:00:00 < time < 2023.12.13 00:00:00

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
queryType	text	否	1	订单查询类型 , 不传或传1代表根据一卡通订单号查询,此时transRecId为一卡通订单号 2代表根据开发者流水号查询,此时transRecId为开发者流水号,清算时间必填 3代表通过二维码串进行查询,此时transRecId为二维码信息
transRecId	text	是	123456	标识号
liquidationDate	text	否	20200101	清算时间，格式：yyyyMMdd（queryType=2时必需）
sign	text	是	QEWQEQWE234234FR	签名

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ transRecId	string	必须	一卡通订单号
├─ monTrans	string	必须	交易金额
├─ recTime	string	必须	到账时间 yyyy-mm-dd HH:mm:ss
├─ accNum	string	必须	用户账号
├─ orderStatus	string	必须	订单状态（0：待交易 1：交易成功 2：交易失败）
├─ sign	string	必须	签名

公告查询

基本信息

Version： ZYTK40_40.20.1130

Path： /api/common/infoqueryservice/querynotice?access_token={access_token}

Method： POST

接口描述：

根据日期获取一卡通的公告内容。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
beginDate	text	是		起始时间，yyyy-mm-dd
endDate	text	是		结束时间，yyyy-mm-dd
typeNum	text	是	1	公告类型，传0表示不进行类型筛选，返回所有类型公告
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ list	object	必须
├─ title	string	必须	标题
├─ content	string	必须	正文
├─ typeNum	string	必须	公告类型,1通知公告2.拾遗公告3.服务网点4.使用指南5.规章制度7.系统公告
├─ postTime	string	必须	公告时间，yyyy/MM/dd HH:mm:ss
├─ sign	string	必须	签名

查询厂家信息

基本信息

Version： ZYTK40_40.20.0731,ET_v5.1.20.0531

Path： /api/common/querydevicemaker?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ makerId	string	必须	厂家序号
├─ makerName	string	必须	厂家名称
├─ person	string	必须	联系人
├─ contact	string	必须	联系方式
├─ sign	string	必须	验签

获取操作员办公场所(易通)

基本信息

Version： ET_v5.1.20.0531

Path： /api/common/operator/querylocation?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
optNum	text	是		操作员账号
sign	text	是		验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ locationNum	string	必须	办公场所编号
├─ locationName	string	必须	办公场所名称
├─ campusId	string	必须	所属园区序号
├─ epId	string	必须	使用单位编号
├─ eWalletId	string	必须	工作钱包序号
├─ campusName	string	必须	所属园区名称
├─ sign	string	必须	验签

获取操作员权限列表

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/operator/querypermissions?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	使用单位编号
areaNums	text	是	对接4.0园区号
optNum	text	是	操作员账号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ moduleCode	string	必须	功能模块编号
├─ moduleName	string	必须	功能名称
├─ parentCode	string	必须	上级功能编号
├─ sign	string	必须	验签

查询设备发行方信息

基本信息

Version： ZYTK40_40.20.0531,ZYTK40_40.20.0731

Path： /api/common/querydevicesupplier?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ supplierId	string	必须	发行方序号
├─ supplierName	string	必须	发行方名称
├─ person	string	必须	联系人
├─ contact	string	必须	联系方式
├─ sign	string	必须	验签

查询使用单位电子现金钱包列表

基本信息

Version： ZYTK40_40.20.0731,ET_v5.1.20.0531

Path： /api/common/queryewallet?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
eWalletType	text	否	钱包类型:1-闭环钱包 2-开环钱包 3-专款专用钱包
countType	text	否	计量类型:1-计额 2-计次
eWalletId	text	否	电子现金钱包序号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	使用单位编号
├─ eWalletId	string	必须	钱包序号
├─ eWalletName	string	必须	钱包名称
├─ tiedEwalletId	string	必须	追扣钱包号
├─ ewalletType	string	必须	钱包类型 1-闭环钱包；2-开环钱包；3-专款专用钱包
├─ countType	string	必须	计量类型 0-记额；1-记次易通5.1.22.0331后支持
├─ sign	string	必须	验签

查询页面交易类型列表

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/querytransactiontype?access_token={access_token}

Method： POST

接口描述：

对接4.0时，将4.0的"营业类"和"扣款类"的交易类型都归在"2-消费类(营业类)"中进行返回
入参时categoryId和feeNum不能同时为空

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
categoryId	text	否	分类编码:1-操作类 2-消费类(营业类) 3-充值类 4-补助类该参数和feeNum参数不能同时为空，40没有充值类
feeNum	text	否	交易类型编号该参数和categoryId参数不能同时为空
areaNums	text	否	对接4.0园区号必传，易通不需要传
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ feeNum	string	必须	类型编号
├─ feeName	string	必须	类型名称
├─ sign	string	必须	验签

查询单商户信息(根据商户编号)

基本信息

Version： ZYTK40_40.20.0531,ZYTK40_40.20.0731

Path： /api/common/querybusiness?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
businessNum	text	是	商户编号
sign	text	是	验签
epId	text	否	租户编号（对接10.0接口必传）

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ businessNum	string	必须	商户编号
├─ businessName	string	必须	商户名称
├─ depNum	string	必须	所属商户部门编号
├─ depName	string	必须	所属商户部门名称
├─ disableDate	string	必须	失效日期 “YYYY-MM-DD”
├─ recFlag	string	必须	禁用标记 0-禁用 1-有效
├─ sign	string	必须	验签

查询使用单位下的身份信息

基本信息

Version： ZYTK40_40.20.0731,ET_v5.1.20.0531

Path： /api/common/queryaccclass?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	使用单位编号
├─ accClassId	string	必须	身份序号
├─ accClassName	string	必须	身份名称
├─ recFlag	string	必须	有效标记 0-无效 1-有效
├─ receptReset	string	必须	是否允许余额复位 0-不允许 1-允许没有就传1
├─ classType	string	必须	身份类别
├─ classTypeStr	string	必须	身份类别名称
├─ sign	string	必须	验签

批量查询账户主卡信息

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getmaincard?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
accNums	text	是	账号拼接的字符串用分号“,”隔开
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ accNum	string	必须	传入的账号
├─ cardAccNum	string	必须	卡账号
├─ cardCode	string	必须	卡内编号
├─ accClassId	string	必须	卡账户身份
├─ cardStatus	string	必须	卡状态 0-销卡 1-有效 2-挂失 3-冻结 4-预销卡 5-锁卡
├─ campusId	string	必须	账户所属易通园区
├─ sign	string	必须	验签

查询账户信息（水控调用，模糊查询）

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731,ZYTK40_40.20.1130

Path： /api/common/queryaccountinfo?access_token={access_token}

Method： POST

接口描述：

接口入参逻辑：
1.queryType字段和uniqueId字段同时使用，当queryType为3时，idType字段为必填项
2.epId字段和areaNums字段分别用于对接易通和4.0，原则上需要传递，但可以不传。不传时则结果中不限定使用单位或者园区进行查询。
3.accNums字段用于多账户查询，不可与queryType和uniqueId字段组合使用。
4.accNums字段和epId(areaNums)字段不允许同时为空；accNums字段、queryType和accName字段不能同时为空。
5.对接4.0时根据areaNums字段判断是否为账户本园区查询，以区分处理返回信息里的账户身份信息；当areaNums为空时，默认返回本园区身份。

ZYTK4.0.20.1130版本增加预撤户状态的返回，返回的状态里增加“2-挂失”状态
ZYTK4.0.22.0331版本areaNums传0的时候，当作单园区处理。
允许可以查出预开户记录

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	否	易通使用单位编号。
areaNums	text	否	对接4.0园区号,epId为空时该值为空。
queryType	text	否	账户查询类型 1-帐号，2-人员编号（模糊查询），3-证件号码，6-手机号码，8社保卡号（塔里木大学15369-社保卡支持水控修改webAPI获取账户信息接口个性化使用）
idType	text	否	证件类型（当queryType为3时 idType字段为必填项），1-身份证，2-护照，3-学生证，4-工作证，5-军官证，6-其他证件，7-台胞证
uniqueId	text	否	标识号（帐号/人员编号/证件号码/手机号码）
accName	text	否	账户名称
accNums	text	否	账号(用“，”隔开可传多个账号也可为空)
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	使用单位编号
├─ accNum	string	必须	账号
├─ perCode	string	必须	个人编号
├─ depName	string	必须	部门名称
├─ accName	string	必须	姓名
├─ contact	string	必须	联系方式(手机号)
├─ sex	string	必须	性别 0-未知 1-男 2-女 9-未说明
├─ idNo	string	必须	证件号码
├─ idType	string	必须	证件类型可根据平台原值传输易通为字典表28 易通平台： 1-居民身份证 2-护照 3-学生证 4-工作证 5-军官证 6-其他证件 7-台胞证
├─ idTypeStr	string	必须	证件类型名称
├─ areaNum	string	必须	卡户所在园区
├─ accClassId	string	必须	账号身份
├─ accStatus	string	必须	账户状态 -2-申请开户 -1-预开户 0-销户 1-有效 2-挂失 3-冻结 4-预销户对接40平台时，只返回有效、挂失、冻结、预撤户四种状态对接易通平台时，返回申请开户、预开户、有效、冻结、预撤户五种状态(无挂失状态)
├─ accClassName	string	必须	账户身份名称
├─ disableDate	string	必须	账户失效时间(yyyy-MM-dd)
├─ sign	string	必须	验签

查询账户列表(带分页)

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/queryaccountlist?access_token={access_token}

Method： POST

接口描述：

**--易通v5.1.22.0531 更新 **
返回字段添加depId、accStatusNum

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
depNums	text	否	账户部门编号多个以”,”隔开
sex	text	否	性别 0-未知 1-男 2-女 9-未说明
accName	text	否	账户名称
perCode	text	否	个人编号
current	text	是	当前页
pageSize	text	是	每页数据条数
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ records	string	必须	总记录数
├─ list	object	必须
├─ accNum	string	必须	账号
├─ perCode	string	必须	个人编号
├─ depId	string	必须	部门编号
├─ depName	string	必须	部门名称
├─ accName	string	必须	姓名
├─ contact	string	必须	联系方式(手机号)
├─ sex	string	必须	性别 0-未知 1-男 2-女 9-未说明
├─ idNo	string	必须	证件号码
├─ idType	string	必须	证件类型
├─ accClassId	string	必须	账号身份
├─ accClassName	string	必须	账户身份名称
├─ accStatusNum	string	必须	账户状态编号，1.有效 3.冻结 4.预销户
├─ sign	string	必须	验签

查询使用单位园区列表(易通单位下园区)

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/querycampuse?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ campusid	string	必须	园区序号
├─ campusName	string	必须	园区名称
├─ remark	string	必须	备注
├─ sign	string	必须	验签

查询账户在使用单位下的首张主卡对应的钱包余额信息

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/queryewalletsbyaccnum?access_token={access_token}

Method： POST

接口描述：

查询账户在指定单位下的主卡钱包余额及可用额度信息
入参中商户编号存在时，需判断商户是否为有效商户。
在线钱包余额(本次可用钱包额度) = (卡余额+待领补助金额) 与 库余额 比较，以小为准。
单钱包时实际可用额度 = 在线钱包余额 - 身份钱包余额下限;
有追扣时实际可用额度 = (主钱包在线钱包余额 - 主钱包身份钱包余额下限) + (追扣钱包在线钱包余额 - 追扣钱包身份钱包余额下限) ;
某个钱包的在线钱包余额- 该钱包的身份钱包余额下限 <= 0 时，直接按0计算。

注：接入易通平台时，若该接口的入参中不含商户号，则不进行追扣钱包的相关处理，因为易通商户可以设置是否允许追扣，无商户号时无法判断追扣情况。
** 接入4.0平台时，无需根据商户号判断是否追扣。**

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
businessNum	text	否	商户编号
accNum	text	是	账号
ewalletId	text	是	钱包号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ accNum	string	必须	账号
├─ campusId	string	必须	账户园区号
├─ cardAccNum	string	必须	卡账号(获取首张有效主卡)
├─ cardCode	string	必须	卡内编号(获取首张有效主卡)
├─ accclassId	string	必须	卡身份序号(有效的身份)
├─ ewalletId	string	必须	钱包号
├─ ewalletCardBalance	string	必须	钱包卡余额+待领补助金额
├─ storeBalance	string	必须	钱包库余额
├─ availableBalance	string	必须	本次可用钱包额度
├─ sign	string	必须	验签

查询账户下主卡的卡账户身份信息

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/queryallaccclassbyaccnum?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对应4.0园区号
accNums	text	是	账号拼接的字符串用分号“,”隔开
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ accNum	string	必须	账号
├─ cardAccNum	string	必须	卡账号
├─ identityId	string	必须	卡账号身份序号(对应单位、园区)
├─ sign	string	必须	验签

查询账户下主卡所有未领补助

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/querysubsidybyaccnums?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
accNums	text	是	账号拼接的字符串用分号“,”隔开
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ accNum	string	必须	账号(4.0对应卡账号)
├─ cardCode	string	必须	卡内编号
├─ ewalletId	string	必须	钱包号
├─ sidBegin	string	必须	起始补助流水号
├─ sidEnd	string	必须	终止补助流水号
├─ moneySum	string	必须	补助金额单位：分 (double)
├─ sign	string	必须	验签

查询使用单位下操作员树

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/queryoperatortree?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ tree	object	必须
├─ id	string	必须	角色编号
├─ text	string	必须	角色名称
├─ children	object	必须	子节点
├─ id	string	必须	操作员编号
├─ text	string	必须	操作员名称
├─ sign	string	必须	验签

查询使用单位下账户部门树

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/queryaccdeptree?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	否	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ id	string	必须	根节点固定为0
├─ text	string	必须	根节点固定为“账户部门”
├─ children	object	必须
├─ id	string	必须	子级账户部门编号
├─ text	string	必须	子级账户部门名称
├─ children	object	必须
├─ id	string	必须	N级账户部门编号
├─ text	string	必须	N级账户部门名称
├─ sign	string	必须	验签

获取云马平台账户信息（通过code）

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getymuserbycode?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
time	text	是	当前时间戳
appid	text	是	云马接口调用需要
code	text	是	云马接口调用需要
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ result	string	必须	云马返回的信息
├─ sign	string	必须	验签

获取云马平台账户信息（通过UserID）

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getymuserbyuserid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
time	text	是	当前时间戳
appid	text	是	云马接口调用需要
userId	text	是	云马接口调用需要
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ result	string	必须	云马返回的信息
├─ sign	string	必须	验签

获取使用单位下所有商户信息

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getbusinessbyepid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ businessNum	string	必须	商户编号(使用单位编号+五位的商户序号)
├─ epId	string	必须	使用单位编号
├─ businessId	string	必须	商户序号
├─ businessName	string	必须	商户名称
├─ disableDate	string	必须	失效日期 “YYYY-MM-DD”
├─ allowTied	string	必须	是否允许追扣 0-不允许 1-允许
├─ takeChargeFee	string	必须	是否收消费管理费 0-不收取 1-收取
├─ allowCancel	string	必须	是否允许销账 0-不允许 1-允许
├─ allowOffLine	string	必须	是否允许脱网 0-不允许 1-允许
├─ allowQuery	string	必须	消费机是否允许查汇总 0-不允许 1-允许
├─ needCancelPWD	string	必须	销账是否输入密码验证 0-不允许 1-允许
├─ cancelPWD	string	必须	销账密码
├─ onLineMaxMoney	string	必须	联网单笔限额
├─ offLineMaxMoney	string	必须	脱网单笔限额
├─ recFlag	string	必须	禁用标记 0-禁用 1-有效
├─ sign	string	必须	验签

获取使用单位系统参数

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731,ET_v5.1.20.1130,ZYTK40_40.20.1130

Path： /api/common/getsystemparambyfixid?access_token={access_token}

Method： POST

接口描述：

当epId为-1时只返回isSingleEp字段，当epId不为-1时返回除isSingleEp以外的所有字段

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ indexSectorId	string	必须	索引扇区编号(易通)
├─ platCustomId	string	必须	平台客户号(ZYTK4.0把客户号和代理号拼接成这个字段)
├─ keyVersion	string	必须	密钥版本号(用不到固定为1)
├─ enableCOS	string	必须	启用的COS列表（对应位为1则表示对应编号的COS启用） 20位
├─ enableCardType	string	必须	启用的卡种列表（包含启用哪部分）共40位，20个卡种。实际下发了前10个卡种。含义：依序每两个数字表示对应类型的卡种参数第一个两位是1号卡种，第二个两位是2号卡种，其中第一个数字表示是否启用（0-未启用，1-启用），第二数字表示启用哪部分（0-ID，1-M1，2-CPU），例如“0012”表示1号卡种没有启用，2号卡种启用CPU部分。
├─ offLineDays	string	必须	脱机天数
├─ enableM1	string	必须	是否只启用M1卡 0-不是 1-是
├─ baseSectorId	string	必须	基本扇区号兼容4.0
├─ extendSectorId	string	必须	扩展扇区号兼容4.0
├─ keyDistributionMode	string	必须	终端使用的密钥模式 0-硬密钥(PSAM卡模式) 1-软密钥默认为0
├─ waterSectorId	string	必须	4.0水控阶梯扇区号
├─ recFlag	string	必须	有效标志 0-无效 1-有效
├─ offlineCodeEffectiveTime	string	必须	二维码有效时长（秒） ET5.1.20.1130、ZYTK40_40.20.1130版本新增
├─ reportLossIsVirturalAvaliable	string	必须	卡片挂失后，联机状态下消费时人脸二维码是否可以使用：0-不可以 1-可以 ET5.1.20.1130版本新增对接易通的默认值为0 ZYTK40_40.20.1130版本新增对接40永远返回1
├─ isSingleEp	string	非必须	当epId为-1时返回是否是单园区 0-多园区 1-单园区
├─ systemVersion	string	非必须	平台版本号例如"5.1.22.0531"、"4.0.22.0531" 易通获取数据库中系统参数表的版本号 ZYTK40获取webapi服务的版本号 ET5.1.22.0731版本新增 ZYTK40_4.0.22.0831版本新增
├─ isDk	string	非必须	是否代扣 0-不代扣 1-聚合支付代扣默认不代扣(40返回)
├─ dkType	string	非必须	代扣模式 1-仅代扣（先充值后消费） 2-优先余额再代扣(40返回)
├─ dkWallet	string	非必须	代扣钱包号(40返回)
├─ whCls	string	非必须	代扣身份串(40返回)
├─ isLocalClass	string	非必须	园区模式(40返回)
├─ sign	string	必须	验签

获取身份钱包参数

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getaccclassewalletparam?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
ewalletId	text	是	工作钱包序号
identityId	text	是	交易身份序号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ workMoneyLimit	string	必须	钱包余额下限一卡通都用0
├─ allowReset	string	必须	是否允许余额复位（易通有，一卡通根据钱包里的余额复位字段填充） 0-不允许 1-允许
├─ sign	string	必须	验签

获取卡账户信息

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0731

Path： /api/common/getaccclassbycardaccnum?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
cardAccNum	text	是	卡账号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ cardAccNum	string	必须	卡账号
├─ campusId	string	必须	园区号
├─ identityId	string	必须	卡账户身份
├─ sign	string	必须	验签

获取账户信息

基本信息

Version： v5.1.20.0115,ZYTK40_40.20.0115

Path： /api/common/infoqueryservice/getaccount?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口获取指定账户信息以及相关附带信息（第一张主卡信息和第一张主卡默认电子现金钱包信息），需要一卡通平台开通授权
注意：

当一卡通账户没有配主卡时，返回的第一张主卡信息和第一张主卡默认电子现金钱包信息全为空字符串。
两种物理卡号的区别。
- 原始物理卡号：遵循业界规范的M1或CPU卡物理卡号，一般是十进制数字；
  正元物理卡号：正元公司在原始物理卡号基础上封装后的物理卡号。算法如下：

假设：oriCardSid(原始物理卡号)=1141422927
1.先把oriCardSid转换成16进制：4408BB4F
2.按低字节在前、高字节在后排列：4FBB0844
3.用‘0’补齐至20位，并转换成小写：4fbb0844000000000000

【ET_v5.1.21.0630】增加encryptFlag参数；使用说明：当需要获取密文结果使用

1. 调用【获取加密因子接口】获得密钥和偏移量；
2. 调用本接口获取数据
3. 使用获取的密钥信息对返回的data内容进行解密，解密方式：见【加解密】【方式一】
4. 解密后的明文为账户信息json字符串："{accDepFullPathName:'',...}"

ZYTK4.0.22.0331版本允许可以查出预开户记录
【ET_v5.1.23.1231】【融合_v8.0.23.1130】增加账户下查不到任何卡账户信息时，说明账户未开卡或卡账户均已销卡，从账户持卡变更记录中获取最后变更卡账户信息（cardAccNum，cardSid，cardStatusNum）返回，
变更人-杨东梅变更时间2024.01.24

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
encryptFlag	text	否	1	返回数据是否加密 1-加密，0-不加密
epId	text	否	1	使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或传0
queryType	text	是	2	账户查询类型（1帐号/2人员编号/3证件号码/4正元物理卡号/5原始物理卡号/6手机号码）
idType	text	否		证件类型（当查询类型为证件号码时必填，1.身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件 7.台胞证）
uniqueId	text	是	20170901	标识号（帐号/人员编号/证件号码/正元物理卡号/原始物理卡号/手机号码）
photoQueryType	text	否	2	照片查询标记 0-无图， 1-证件照， 2-人脸照， 3-所有
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	必须	encryptFlag=1时,为加密后的密文数据
├─ accDepFullPathName	string	必须	账户部门全路径名称
├─ accDepName	string	必须	账户部门名称
├─ accDepNum	string	必须	账户部门编号
├─ accName	string	必须	账户姓名
├─ accNum	string	必须	帐号
├─ accStatusNum	string	必须	账户状态编号，-2.申请开户 -1.预开户 0.销户 1.有效 3.冻结 4.预销户 99.账户已过期
├─ birthday	string	必须	出生日期
├─ campusId	string	必须	园区序号
├─ campusName	string	必须	园区名称
├─ clsName	string	必须	身份名称
├─ clsNum	string	必须	身份编号
├─ disableDate	string	必须	账户失效日期
├─ email	string	必须	邮箱
├─ idNo	string	必须	证件号码
├─ idTypeNum	string	必须	证件类型编号 1.身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件 7.台胞证
├─ isFreezed	string	必须	冻结充值状态编号，0：未冻结充值 1：冻结充值
├─ joinDate	string	必须	入职日期
├─ nativePlace	string	必须	籍贯
├─ perCode	string	必须	人员编号
├─ zkPerCode	string	必须	中控13位人员编号
├─ phoneNo	string	必须	手机号码
├─ qq	string	必须	qq号码
├─ rechargeable	string	必须	是否可充值 0：不可以 1：可以
├─ rechargeableAmount	string	必须	可充值金额,格式是XX.XX元
├─ sexNum	string	必须	性别编号，0.未知 1.男 2.女 9.未说明
├─ cardAccNum	string	必须	卡账号
├─ cardAlias	string	必须	卡别名
├─ cardSid	string	必须	原始物理卡号，十进制，2024.0124新增账户下查不到任何卡账户信息时，说明账户未开卡或卡账户均已销卡，从账户持卡变更记录中获取最后变更卡号
├─ cardStatusNum	string	必须	卡片状态编号，0.销卡 1.有效 2.挂失 3.冻结 4.预销卡 5.锁卡
├─ mainOrViceNum	string	必须	主副卡编号，1.主卡 2.副卡
├─ balance	string	必须	主卡默认钱包余额,格式是XX.XX元
├─ eWalletId	string	必须	钱包序号
├─ eWalletName	string	必须	钱包名称
├─ idZipPhoto	string	必须	用户上传的证件照压缩图,使用Base64编码形式
├─ faceOriPhoto	string	必须	用户上传的人脸照原图,使用Base64编码形式
├─ sign	string	必须	签名

获取匿名支付参数信息

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/getanonymousparam?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询一卡通匿名支付参数（除此之外，聚合支付也可以将此接口当作心跳接口，检测一卡通是否在线），该接口需要权限认证。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
openId	text	是	1
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ flag	string	必须	是否启用匿名支付，0表示未启用，1表示启用
├─ accNum	string	非必须	匿名支付一卡通账号，未启用匿名支付时为空
├─ qrCodeUrl	string	必须	云马聚合二维码地址
├─ sign	string	必须	签名

交易流水查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/querytransaction?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询一卡通交易流水，交易流水根据交易时间倒序排列，该接口需要权限认证。
zytk40交易流水分为当前流水和历史流水，当开始时间和结束时间都是今天的时候，接口会查询当前流水，其他情况均查询历史流水，传交易类型的时候 40只需传feeNums，查单个就只传一个交易类型即可
4.0.20.0531之前的版本为正序排列，4.0.20.0531之后的版本为倒序排列
21.0530：开始交易时间和结束交易时间要么都为空，要么都传值，不然会提示参数错误，为空的时候默认查询7天内流水。
21.0831：zytk40交易流水查询的时候按照开始时间和结束时间查询流水，可以拼接当前流水和历史流水。增加交易方式返回参数

2023.11.01：更新查询返回支付渠道备注说明 40不返回支付渠道

payWay易通已不返回该字段

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
recNum	text	否	2	一卡通交易流水号
accNum	text	否	2	帐号
feeNum	text	否	100	交易类型编号（40这个参数不用）
feeNums	text	否	46,100	交易类型编号范围，以逗号(英文符号)分隔，如“46,100”
eWalletId	text	否	1	钱包序号
businessNum	text	否	100001	商户编号
startDealTime	text	否	2017-01-01 00:00:00	开始交易时间 yyyy-mm-dd HH:mm:ss（边界：>=开始交易时间）
endDealTime	text	否	2017-01-02 23:59:59	结束交易时间 yyyy-mm-dd HH:mm:ss（边界：<结束交易时间）
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ accName	string	非必须	姓名
├─ accNum	string	非必须	一卡通帐号
├─ businessName	string	非必须	商户名称
├─ businessNum	string	非必须	商户编号
├─ cardAccNum	string	非必须	卡帐号（40不支持）
├─ uploadTime	string	非必须	到账时间 yyyy-mm-dd HH:mm:ss
├─ deviceName	string	非必须	设备名称（4.0为站点名称）
├─ deviceNum	string	非必须	设备编号（4.0为站点号）
├─ eWalletId	string	非必须	钱包序号
├─ eWalletName	string	非必须	钱包名称
├─ feeName	string	非必须	交易类型名称
├─ feeNum	string	非必须	交易类型编号
├─ isRed	string	非必须	是否是冲正流水，0：否 1：是（40不支持）
├─ monCard	string	非必须	卡余额
├─ monDb	string	非必须	库余额
├─ monDeal	string	非必须	交易金额
├─ monDiscount	string	非必须	优惠金额
├─ optName	string	非必须	操作员名称（40不支持）
├─ optNum	string	非必须	操作员编号
├─ perCode	string	非必须	人员编号/校园卡号
├─ payWay	string	非必须	交易方式（0其它、1二维码、2人脸）
├─ recFlag	string	非必须	一卡通交易流水状态, ：0,无效流水, 1,有效流水, 2,TAC验证失败, 3,开环流水, 4,重帐流水, 5,灰交易, 6,库余额不合法, 7,异常流水, 14,已处理的异常流水8,销卡前流水;（40不支持）
├─ redFlag	string	非必须	是否被冲正，0：否 1：是（40不支持）
├─ recNum	string	非必须	一卡通交易流水号
├─ dealTime	string	非必须	交易时间 yyyy-mm-dd HH:mm:ss
├─ transChannel	string	非必须	支付渠道（字典表267）：-1,现金, 0,无, 1,平台钱包, 2,银行卡, 4,无, 5,支付宝, 6,微信, 7,iPay88, 8,翼支付, 9,E路通, 10,银联, 11,龙支付, 12,和包, 13,校园卡, 14,云马, 15,微校, 16,威富通, 17,农业银行, 18,付费通, 19,易校园, 20,工商银行, 21,建行e码通, 22,招行,, 23,银联商业服务部, 24,工行融e联, 25,钉钉, 26,e福州, 27,易校园钱包, 28,中行支付, 30,光大银行, 31,宁波银行, 32,贵州农信行业应用, 33,江苏银行, 36,中行一码通, 37,柳州银行, 38,交通银行, 39,济宁银行, 40,华融湘江银行, 41,邮储银行, 42,河北农信社支付, 43,浙商银行支付, 44,交行数字货币, 45,建行数字货币, 46,工行数字货币, 47,中行数币, 48,农行数字货币, 49,河北银行, 50,浙江农信, 52,中行一码通红包, 56,工行聚富通, 61,中国建设银行, 62,电子券, 63,江苏省农商银行;
├─ transInterfaceType	string	非必须	转账发起类型（字典表187）：-1,现金, 0,其他, 1,第三方支付, 2,支付宝, 3,微信, 4,易通管理平台, 5,门户网站, 6,易通手机APP, 7,自助终端, 8,财务缴费网站, 9,报名系统, 10,翼支付, 11,E路通, 12,银联, 13,龙支付, 14,和包, 15,校园卡, 16,云马, 17,微校, 18,威富通, 19,农业银行, 20,付费通, 21,易校园, 22,工商银行, 23,建行e码通, 24,招行, 25,银联商业服务部, 26,工行融e联, 34,贵州农信行业应用, 35,江苏银行, 32,光大银行, 27,钉钉, 28,e福州, 29,易校园钱包, 30,中行支付, 33,宁波银行, 38,中行一码通, 39,柳州银行, 40,交通银行, 41,济宁银行, 42,华融湘江银行, 43,邮储银行, 44,河北农信社支付, 45,浙商银行支付, 46,交行数字货币, 47,建行数字货币, 48,工行数字货币, 49,中行数币, 50,农行数字货币, 51,河北银行, 54,中行一码通红包, 58,工行聚富通, 59,中国建设银行, 60,电子券, 61,江苏省农商银行, 52,浙江农信;
├─ idType	string	必须	识别类型：0：无（其他），1扫码，2脸谱
├─ transType	string	必须	操作类型：0,其他, 1,操作类, 2,消费类, 3,充值类, 4,消费充值, 5,缴费充值, 6,消费类对账, 7,充值类对账, 8,消费充值对账, 9,缴费充值对账, 10,配卡充值, 11,配卡充值对账, 12,自助开卡;
├─ scanType	string	必须	扫码方式：0：手机扫pos 1：pos扫手机
├─ count	string	必须	记录总条数
├─ sign	string	非必须

证件照信息查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/queryphoto?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询指定账户上传的证件照片，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	2	一卡通帐号，可以通过【获取账户信息接口】获得。
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ accNum	string	非必须	一卡通帐号
├─ photo	string	非必须	用户上传的照片,使用Base64编码形式
├─ modifyDate	string	非必须	最后一次修改时间
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

账户信息查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/queryaccount?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询账户信息，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
epId	text	否		使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传
accDepNum	text	否	1	账户部门编号
accNum	text	否	2	一卡通账号
perCode	text	否	1	个人编号/人员编号
accName	text	否	张三	账户姓名（前后模糊查询）
sexNum	text	否	1	性别编号，0-未知 1-男 2-女 3- 未说明
phoneNo	text	否	13312345678	手机号码，精确查询
sign	text	是	QEWQEQWE234234FR

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ accNum	string	非必须	账号
├─ accName	string	非必须	账户名称
├─ perCode	string	非必须	人员编号
├─ accDepId	string	非必须	账户部门编号
├─ accDepName	string	非必须	账户部门名称
├─ sexNum	string	非必须	性别编号，0-未知 1-男 2-女 3- 未说明
├─ accStatus	string	非必须	账户状态，具体查看【数据字典-账户状态】
├─ phoneNo	string	非必须	手机号码
├─ totalNum	number	非必须	总条数
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

部门信息查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/querydep?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询部门信息，需要一卡通平台开通授权。

ZYTK40.22.1111改动：增加count字段用于返回当前条数，totalNum返回总条数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
epId	text	否		使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ accDepId	string	非必须	部门编号
├─ accDepname	string	非必须	部门名称
├─ parentId	string	非必须	上级部门编号
├─ totalNum	number	非必须	总条数
├─ count	number	非必须	当前返回条数 BY40.22.1111添加
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

商户信息查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/querybusiness?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询商户信息，需要一卡通平台开通授权。
排序方式：商户编号升序

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
epId	text	否		使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ businessNum	string	非必须	商户编号
├─ businessName	string	非必须	商户名称
├─ totalNum	number	非必须	总条数
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

设备信息查询

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/querydevice?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询设备信息，需要一卡通平台开通授权。
排序方式：主：商户编号升序，次：设备编号升序
只查询商户有效未过期且有效的设备的信息

ZYTK40.22.1111改动：增加count字段用于返回当前条数，totalNum返回总条数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
epId	text	否		使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传
deviceCategory	text	是	1	设备大类（暂时只支持 1-以太网消费机）
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ businessNum	string	非必须	设备所属商户编号
├─ businessName	string	非必须	设备所属商户名称
├─ deviceNum	string	非必须	设备编码
├─ deviceName	string	非必须	设备名称
├─ totalNum	number	非必须	总条数
├─ count	number	非必须	当前返回条数 BY40.22.1111
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

一卡通二维码解析

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0831

Path： /api/common/infoqueryservice/parseqrcode?access_token={access_token}

Method： POST

接口描述：

开发者可以在扫描一卡通二维码时，通过该接口解析二维码并返回相应信息，需要一卡通平台开通授权。
应用场景： 一卡通二维码分以下几种类型，开发者调用本接口可以识别不同类别的二维码，从而处理不同的业务逻辑。
1：账户码 2：商户码（不带交易金额） 3：商户码（带交易金额） 4：考勤码 5：门禁码6：第三方二维码。
场景1（二维码消费）：
在扫描一卡通消费POS机上的二维码时，调用本接口识别到二维码类别（类别为3）以及交易金额后，跳转到支付确认界面，用户确认金额后点击“确认支付”按钮，~~此时调用【二维码消费】接口产生消费流水，完成消费。~~
然后调用【预下单】、【订单处理】接口进行交易扣款。
场景2（二维码转账）：
在扫描另一个一卡通用户的二维码时，调用本接口识别到二维码类别（类别为1）后，跳转到转账界面，用户输入转账金额后点击“转账”按钮，此时调用【二维码转账】接口产生转账流水，完成转账。
场景3（二维码开门）：
在扫描一卡通门禁机上的二维码时，调用本接口识别到二维码类别（类别为5）后，此时调用【二维码开门】接口发送开门指令，完成开门。
场景4（二维码考勤）：
在扫描一卡通考勤机上的二维码时，调用本接口识别到二维码类别（类别为4）后，此时调用【二维码考勤】接口记录考勤数据，完成考勤。
注意：
1.本接口可以认证不同类型的一卡通二维码，非一卡通二维码则会返回对应的错误码。
2.当二维码类型是商户码时，需结合【支付消费-二维码消费】接口完成消费；
3.当二维码类型是账户码时，需结合【支付消费-二维码转账】接口完成转账；
4.当二维码类型是门禁码时，需结合【门禁考勤-二维码门禁】接口完成开门；
5.当二维码类型是考勤码时，需结合【门禁考勤-二维码考勤】接口完成考勤。

zytk40.21.0430版本返回参数新增了商户号
ET_v5.1.21.0831版本易通接口调整：

解析账户码增加返回数据：码生成时间；
解析商户码时增加返回数据：商户号和设备编号；
解析门禁考勤二维码时增加返回数据：码生成时间和设备编号；
判断门禁二维码失效时间改为以数据库时间做比较。

ET5.1.23.1231 接口支持dealerNum，解第三方码按商户找openId

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token	3135646566316537653235296A7A8BA60898C934E61455080E4A523D7808C72EEF51AE66533BD9992C319E30E3C6D8	访问凭证

Body

参数名称	参数类型	是否必须	示例	备注
qrCode	text	是	35302E578BFFA6B746A798F794A749EBC6ADEE86407930D,47669	一卡通二维码
epId	text	否	1	使用单位编号
dealerNum	text	否		商户号（解第三方码需要）
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
openId	text	是		易通优先用该openId解第三方码，且易通非必传

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
├─ type	string	非必须	二维码类型，1：账户码 2：商户码（不带交易金额） 3：商户码（带交易金额） 4：考勤码 5：门禁码 6：第三方二维码
├─ accNum	string	非必须	账号，二维码类型为1、6：账户码时有值
├─ perCode	string	非必须	人员编号，二维码类型为1、6：账户码时有值
├─ accName	string	非必须	账户姓名，二维码类型为1、6：账户码时有值
├─ cardAccNum	string	非必须	卡帐号，二维码类型为1、6：账户码时有值
├─ amount	string	非必须	消费金额，格式是XX.XX元，二维码类型为3：商户码（带交易金额）时有值
├─ dateTime	string	非必须	二维码创建的时间戳。例如：2021-01-08 15:31:30
├─ dealerNum	string	非必须	商户号，二维码类型为2/3：商户码时有值
├─ staNum	string	非必须	站点号，二维码类型为2/3：商户码时有值
├─ payType	string	非必须	交易渠道，1：支付宝，2：校园卡，3：微信，4：银联，5：云马，6：建行龙支付，7：腾讯微校，8：威富通，9：农业银行，10：翼支付，11：建行e码通，12：招商银行，13：银联商服，14：工行融e联，15：钉钉，16：E福州，17：易校园钱包，18：中行支付，19：光大银行（4.0暂不支持），20：工商银行（易通5.1.21.0630版本新增，4.0暂不支持），21：贵州农信（易通5.1.21.0630版本新增，4.0暂不支持），22：江苏银行（易通5.1.21.0630版本新增，4.0暂不支持），23：柳州银行（易通5.1.21.0831版本新增，4.0暂不支持），24：交通银行（易通5.1.21.0831版本新增，4.0暂不支持），25：济宁银行（易通5.1.21.0831版本新增，4.0暂不支持），26：华融湘江银行（易通5.1.21.0831版本新增，4.0暂不支持）
├─ transRecId	string	非必须	一卡通订单号，二维码类型为6：第三方二维码时有值

获取钱包余额

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0531

Path： /api/common/infoqueryservice/getewallet?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	2	一卡通帐号，可以通过【获取账户信息接口】获得。
cardAccNum	text	是	2	卡账号，可以通过【获取账户信息接口】获得默认卡片的卡账号（40可不填）
eWalletId	text	否	1	钱包序号，不传时取默认钱包。
epId	text	否	1	使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传,不传时取账户所属使用单位
sign	text	是	QEWQEQWE234234FR

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ accNum	string	非必须	帐号
├─ balance	string	非必须	钱包余额
├─ cardAccNum	string	非必须	卡帐号
├─ eWalletId	string	非必须	钱包序号
├─ eWalletName	string	非必须	钱包名称
├─ tieEwalletObject	object	非必须	追扣钱包对象
├─ accNum	string	非必须
├─ balance	string	非必须
├─ cardAccNum	string	非必须
├─ eWalletId	string	非必须
├─ eWalletName	string	非必须
├─ sign	string	非必须

一卡通交易策略查询

基本信息

Version： ZYTK40_40.20.0731

Path： /api/common/infoqueryservice/querystrategy

Method： POST

接口描述：

40.20.0731版本接口只有优惠策略参数返回（list）,

chargefeelist将在后续版本中加入

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	是		使用单位编号，调用易通是必传
periodNums	text	是	1,2,3,4	营业时段号，多个营业时段号用 ',' 隔开
clsNum	text	是	33	身份编号
staNum	text	是	1	站点号，40必传，易通可以不处理
ewalletNum	text	是		钱包号，易通需要
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ staNum	string	非必须	站点号
├─ staName	string	非必须	站点名称
├─ clsNum	string	必须	身份编号
├─ periodNum	string	必须	营业时段号
├─ periodName	string	必须	营业时段名称
├─ concessionsMode	string	必须	优惠模式（0：免费 1：折扣 2：定额优惠 3：定额消费）
├─ concessionsData	string	必须	优惠额度（折扣返回0-100的百分比）
├─ consstartTime	string	必须	优惠限次
├─ concessionsLimit	string	必须	优惠金额
├─ chargefeelist	object	必须
├─ staNum	string	必须	站点号
├─ staName	string	必须	站点名称
├─ clsNum	string	必须	身份编号
├─ ewalletNum	string	必须	钱包号
├─ takeChargeFee	string	必须	是否收取消费管理费（0-不收取；1-收取）
├─ chargeFeeMode	string	必须	消费管理费收取模式（1.按百分比收取； 2.按次定额收取）
├─ chargeFeeMoney	string	必须	消费管理费收取额度
├─ durationCFMode	string	必须	营业时段消费管理费收取方案(1-仅第一笔收取；2-按餐累收取；3-每笔收取；4.第N笔收取)
├─ durationCFMoney	string	必须	营业时段消费管理费起征量
├─ sign	string	必须	签名

卡户钱包累计优惠次数&金额查询

基本信息

Version： ZYTK40_40.20.0731

Path： /api/common/infoqueryservice/queryaccwalletsum

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
accNum	text	是	帐号
cardAccNum	text	否	卡账号
ewalletNum	text	是	钱包号
periodNum	text	是	营业时段号
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accNum	string	必须	帐号
├─ ewalletNum	string	必须	钱包号
├─ monSum	string	必须	累计优惠金额
├─ timesSum	string	必须	累计优惠次数
├─ sign	string	必须	签名

门禁流水查询

基本信息

Version： ZYTK40_40.20.0731,ET_v5.1.20.0731,ET_v5.1.23.1231

Path： /api/common/infoqueryservice/queryacceventrecord?access_token={access_token}

Method： POST

接口描述：

40.21.1231之前不支持门禁机流水查询，只支持考勤机和考勤一体机
ET5.1.23.1231增加deviceNum，doorNum字段

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	否	1	账号
optNum	text	否	1001	操作员编号，接易通必须传
start	text	是	1	从第几条开始
limit	text	是	20	每页限制几条
startTime	text	是	2019-01-01 12:12:12	查询起期，易通查询起止期限是1年
endTime	text	是	2019-01-01 12:12:12	查询止期，易通查询起止期限是1年
inOrOut	text	否	1	进出门方向 1-进 2-出（易通）
enterType	text	否	1	进门方式，0-刷卡（默认） 1-刷脸 2-虹膜 3-指纹 4-扫码（易通）
eventIds	text	否	1,2	门禁事件编号多个以英文逗号","分隔
clsNum	text	否	1	卡户身份编号
accDepts	text	否	1,2,3	账户部门范围，多个账户部门编号以英文逗号","分隔
deviceNums	text	否	756,856	平台门禁机设备的设备编号，多个设备编号以英文逗号","分隔（易通）
doorNums	text	否	1,2,3	门编号，多个以英文逗号","分隔
orderType	text	否	0	0-升序，1-降序，不传，默认升序
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须
├─ count	string	必须	总条数
├─ list	object	必须
├─ recId	string	必须	事件记录号
├─ cardSID	string	必须	卡号
├─ accNum	string	必须	帐号
├─ accName	string	必须	姓名
├─ accDepFullPath	string	非必须	部门全路径
├─ percode	string	必须	个人编号
├─ ocurrDateTime	string	必须	事件发生时间
├─ deviceNum	string	非必须	设备编号(ET5.1.23.1231增加)
├─ deviceName	string	非必须	设备名称
├─ doorNum	string	非必须	门编号(ET5.1.23.1231增加)
├─ doorName	string	非必须	门名称
├─ enterTypeName	string	非必须	进门方式名称
├─ deviceSN	string	非必须	设备序列号
├─ enterType	string	非必须	事件触发类别 0-刷卡，1-人脸，2-虹膜，3-指纹 4-二维码（40 0-刷卡，1-人脸，2-二维码，3-指纹）
├─ eventName	string	非必须	触发事件名称
├─ inOrOutName	string	非必须	进出方向（40不支持）

第三方交易流水查询

基本信息

Version： ZYTK40_40.20.0731

Path： /api/common/infoqueryservice/querythirdpaymentbook?access_token={access_token}

Method： POST

接口描述：

4.0云马第三方对账查流水用，易通原查流水接口已满足
40.21.0831增加返回参数optType

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从哪一条开始（包括此条）
limit	text	是	10	查几条
startDealTime	text	是		开始交易时间 yyyy-MM-dd HH:mm:ss
endDealTime	text	是		结束交易时间 yyyy-MM-dd HH:mm:ss
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ count	string	必须	总数
├─ list	object	必须	数据集
├─ recNum	string	必须	一卡通订单号
├─ accName	string	必须	卡户姓名
├─ accNum	string	必须	卡户帐号
├─ opName	string	必须	对接方
├─ accAreaNum	string	必须	卡户所在园区
├─ eWalletId	string	必须	钱包号
├─ staNum	string	必须	站点号
├─ staName	string	必须	站点名
├─ businessName	string	必须	商户名
├─ businessNum	string	必须	商户编号
├─ dealTime	string	必须	交易时间
├─ uploadTime	string	必须	到账时间
├─ monDeal	string	必须	交易金额
├─ feeNum	string	必须	交易类型编号
├─ feeName	string	必须	交易类型
├─ optType	string	必须	聚合支付的opttype： 1：充值消费 2：充值消费冲正 3：充值 4：充值冲正 5：消费 6：消费冲正
├─ payRecID	string	必须	一卡通流水号
├─ proofNum	string	必须	对接方流水号
├─ sign	string	必须	签名

一卡通查询代理号与客户号

基本信息

Version： ET_v5.1.20.0731,ZYTK40_40.20.0831

Path： /api/common/infoqueryservice/getagentidandclientid

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须	签名
├─ clientId	string	必须	客户号
├─ agentId	string	必须	代理号

系统对接

根据版本号获取账户信息

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccinfobyfixid?access_token={access_token}

Method： POST

接口描述：

【变更记录】24.01.22 杨东梅
卡号cardSid、物理卡号decimalismCardSid字段，账户销户或卡片销卡时返回账户持卡信息表中的最新变更记录中的卡号
【变更记录】24.01.31 杨东梅
新增返回卡账号cardAccNum,卡类型cardType,出入系统向第三方同步的卡标识syncCardSid(当卡类型是虚拟卡是用卡账号同步）
以上内容于23.1231版本中发布

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
startAccFixId	text	是	1	起始版本号
endAccFixId	text	是	100	结束版本号
epId	text	否	1	易通使用单位，如果不传，默认使用access_token中的epid
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ accNum	string	必须	卡户帐号
├─ perCode	string	必须	个人编号
├─ accName	string	必须	卡户姓名
├─ accStatusNum	string	必须	卡户状态(0销户，1有效，3冻结，4预销户，-1预开户，-2申请开户)
├─ sexNum	string	必须	性别编号，性别编号，0.未知 1.男 2.女 9.未说明
├─ campusId	string	非必须	园区号
├─ idType	string	非必须	证件类型(参照数据字典)(ET5.1.22.1130新增)
├─ idNo	string	非必须	证件号
├─ birthday	string	非必须	生日
├─ phoneNo	string	非必须	电话
├─ nativePlace	string	非必须	籍贯
├─ clsNum	string	必须	身份编号
├─ accDepNum	string	必须	部门编号
├─ department	string	非必须	末级部门名称
├─ accDepFullPathName	string	非必须	部门全路径名称
├─ schoolInstitute	string	非必须	学院
├─ schoolMajor	string	非必须	专业
├─ grade	string	非必须	年级
├─ schoolClass	string	非必须	班级
├─ cardAccNum	string	必须	卡账号
├─ cardType	string	必须	卡类型，0-虚拟卡；1-M1卡；2-CPU；3-SIMPASS；4-UIMPASS；5-RFUIM；6-RFSIM；7-市民卡；8-M1CPU混合卡；9-中国电信SIM卡；10-中国移动SIM卡
├─ syncCardSid	string	必须	当卡类型是虚拟卡是用卡账号同步，物理卡用物理卡号同步（10进制）
├─ cardSid	string	非必须	物理卡号(16进制)(ZYTK4.0返回十进制的卡号),账户销户或卡片销卡时返回账户持卡信息变更表中的末次使用卡号
├─ decimalismCardSid	string	非必须	物理卡号(10进制)，账户销户或卡片销卡时返回账户持卡信息表中的末次使用卡号
├─ cardStatus	string	非必须	卡状态(0销卡，1有效，2挂失，3冻结，4预销卡，5锁卡)
├─ accFixId	string	必须	卡户版本号
├─ accType	string	非必须	人员类别（ZYTK4.0不返回）
├─ sign	string	必须	签名
├─ currentAccFixId	string	必须	当前数据中最大版本号
├─ count	string	必须	账户数量

获取卡户信息当前版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccfixid?access_token={access_token}

Method： POST

接口描述：

注意：
返回的版本号为卡账户身份信息版本号，可去”am_accountcard_accclass”表中进行查询比对

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否		易通使用单位，如果不传，默认使用access_token解析出的epid
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accFixId	string	必须	卡户信息当前版本号
├─ sign	string	必须	签名

获取账户证件照/人脸当前版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccphotofixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
photoType	text	是	0	照片类型，0：证件照，1：人脸
签名	text	是		sign

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ photoFixId	string	必须	证件照/人脸当前版本号
├─ sign	string	必须	签名

根据版本号获取账户证件照/人脸照片

基本信息

Version： ZYTK40_40.20.0531,ET_v5.1.20.0531,ET_v5.1.22.0531

Path： /api/common/systemdocking/getaccphotobyfixid?access_token={access_token}

Method： POST

接口描述：

注意：易通22.0531版本后，对接身份核验情况下，将查询从startPhotoFixId版本开始，总计endPhotoFixId-startPhotoFixId条数据，这些记录的版本号可能在endPhotoFixId之后，加快同步速度。
例：对接身份核验版本
第一次 start=1，end = 10（这里因为是第一次，并不知道版本号，这里表达的是我想取10条人脸），response结果可能为photoFixId=12626 到 photoFixId = 12636 共10条数据（且返回的数据是不按版本号排序的）
第二次（因为有了第1次的返回版本号）start=12637（这里是上一次返回数据里的最大版本号+1[因为数据不排序，需要第三方来找到最大版本号]），end = 12647（这里不是真实的版本号，是为了代表我再想取10条数据，所以以当前的start+1），response结果可能photoFixId= 12671 到 photoFixId=19034 共10条数据
第三次 start=19035 end=19045 （然后以此类推）

纯易通版本
start=开始人脸版本号[第三方需要存下来]，end=通过“获取人脸最大版本号”拿到的值

40
24.0516：如果每次查询大于100条，则只返回100条的数据，防止一卡通内存溢出

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
photoType	text	是	照片类型，0：证件照，1：人脸
startPhotoFixId	text	是	开始版本号
endPhotoFixId	text	是	结束版本号(为确保执行效率，每次查询条目最好不超过100)
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ accNum	string	必须	帐号
├─ perCode	string	必须	个人编号
├─ photo	string	必须	证件照/人脸照片，base64字符串
├─ photoFixId	string	必须	照片版本号
├─ accType	string	非必须	人员类别(1学生，2教工，3其他人员，4临时人员)（40暂不支持）
├─ faceStatus	string	必须	人脸照照片状态，查询人脸照才会返回此参数（0无效，1有效）注：查询OM_ACCOUNTPERSONALISE表中SUPPKEY='facePhotoState'的SUPPVALUE字段的值，OM_ACCOUNTPERSONALISE表必须要易通h5-我的-安全中心-刷脸设置-刷脸功能开启过才会有人脸状态数据，如未开启过，接口默认返回0，但能下发人脸给设备（为了兼容没有h5的现场能默认下发人脸），如果有h5的现场需要不下发人脸照片给设备，需要手动开启开关后关闭才不会下发人脸
├─ accName	string	必须	姓名
├─ sign	string	必须	签名
├─ count	string	必须
├─ currentPhotoFixId	string	必须

获取指定门的人员进出记录当前版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccdoorrecordsfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
doorNum	text	否		门编号
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ doorNum	string	必须	门编号
├─ drFixId	string	必须	当前门的进出记录版本号
├─ sign	string	必须	签名

获取人员进出新增记录

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccdoorrecordsbyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
startDrFixId	text	是	起始版本号
endDrFixId	text	是	结束版本号
doorNum	text	否	门编号(40为必传参数)
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ drFixId	string	必须	版本号（门禁记录编号）
├─ accNum	string	必须	帐号
├─ perCode	string	必须	个人编号
├─ accName	string	必须	卡户姓名
├─ doorNum	string	必须	门编号
├─ doorName	string	必须	门名称
├─ eventId	string	必须	事件编号
├─ inOrOutCode	string	必须	进出方向（1进，2出）40中0表示未知
├─ occurTime	string	必须	门禁事件发生时间 yyyy-MM-dd HH:mm:ss
├─ sign	string	必须	签名
├─ count	string	必须	数据条数
├─ currentDrFixId	string	必须	当前数据中最大版本号

更新公寓房间信息

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/updateapartmentinfo?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
code	text	是		层级编号
parentCode	text	是		父层级编号
buildName	text	是		层级名称
codeType	text	是		节点类型，1-园区，2-楼栋，3-层级，4-房间，易通必传
fullName	text	是	杭师大仓前校区-紫竹院-1号楼-101室	全路径名
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

获取第三方对接公寓房间信息版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getapartmentinfofixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ buildFixId	string	必须	公寓房间信息版本号
├─ sign	string	必须	签名

根据版本号获取第三方对接公寓房间信息

基本信息

Version： ET_v5.1.20.0630

Path： /api/common/systemdocking/getapartmentinfobyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
startFixId	text	是	1	起始版本号
endFixId	text	是		结束版本号
codeType	text	是		节点类型(1-园区，2-楼栋，3-层级，4-房间) 如果不传代表获取版本号期间的所有资源
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ data	object	必须
├─ code	string	必须	资源码
├─ parentCode	string	必须	父层级编号(园区没有父层级编号)
├─ grandpaCode	string	必须	父父层级编号(房间有此字段)
├─ buildName	string	必须	层级名称
├─ buildingType	string	必须	楼宇类型(只有楼栋类型有该字段。1办公楼，2宿舍楼，3教学楼，4综合楼)
├─ codeType	string	必须	节点类型(1-园区，2-楼栋，3-层级，4-房间，易通必传)
├─ accRoomFixId	string	必须	版本号
├─ sign	string	必须

获取第三方对接账户住宿信息版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getaccroominfofixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accRoomFixId	string	必须	住宿信息版本号
├─ sign	string	必须	签名

根据版本号获取第三方对接账户住宿信息

基本信息

Version： ET_v5.1.20.0630

Path： /api/common/systemdocking/getaccroominfobyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
startFixId	text	是	开始版本号
endFixId	text	是	结束版本号
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ roomNum	string	必须	房间号
├─ perCode	string	必须	个人编号
├─ openDate	string	必须	开户时间(yyyy-MM-dd HH:mm:ss)
├─ accType	string	必须	人员类别(1学生，2教工，3其他人员，4临时人员)
├─ accRoomFixId	string	必须	版本号
├─ sign	string	必须	签名

更新账户住宿信息

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/updateaccroom?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
roomNum	text	是	房间编号（对接方的房间编号，非易通房间号）
perCode	text	是	个人编号
isVaild	text	是	是否生效，0-生效，1-不生效，不生效的时候删除住宿信息
accRoomFixId	text	是	版本号
sign	text	是	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

获取第三方对接进出权限版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/getdoorpowerfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ dpFixId	string	必须	门禁权限版本号
├─ sign	string	必须	签名

变更进出权限（可批量）

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/systemdocking/updateaccroompower?access_token={access_token}

Method： POST

接口描述：

不支持跨单位
此接口新建于2020年06月30号。
接口变更记录：
zytk40_40.21.0831 入参accNum修改成perCode
ZYTK4.0.21.1231 支持批量操作，入参perCode和doorNum可以传多个值~~~~（易通暂不支持批量操作）

**--易通v5.1.22.0531 更新 **
易通支持批量变更但perCode数量 * doorNum数量不得超过200条

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
perCode	text	是	个人编号（可传多个个人编号','分隔例：11,22,33）
doorNum	text	是	门编号 (可传多个门号','分隔例：1,2,3,4)
validTime	text	是	生效时间(格式必须为yyyy-MM-dd HH:mm:ss)（仅易通需要）
dpFixId	text	是	对接方的门禁权限版本号（如果不需要同步权限，只需要变更权限功能的，传0即可）
isVaild	text	是	是否生效，0-生效，1-不生效，不生效的时候删除权限
optNum	text	是	操作员编号，易通平台需要，由易通系统创建好后分配
durationId	text	否	营业时段分组编号（允许进出时段组中的分组，未传时使用最小的营业时段分组编号）（40不支持）
disableTime	text	否	失效时间(格式必须为yyyy-MM-dd HH:mm:ss)（仅易通需要）
sign	text	是	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

获取部门信息当前版本号

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.21.1231

Path： /api/common/systemdocking/getaccdepfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accDepFixId	string	必须	部门信息当前版本号
├─ sign	string	必须	签名

根据版本号获取部门信息

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.21.1231,ET_v5.1.23.1231

Path： /api/common/systemdocking/getaccdepinfobyfixid?access_token={access_token}

Method： POST

接口描述：

易通5.1.23.1231新增参数isNeedInvalidData 是否需要无效部门数据 1-是，将返回无效的部门，0-否，只返回有效的部门
返回字段recFlag 部门有效状态，0-无效，1-有效

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
startAccDepFixId	text	是	0	起始版本号
endAccDepFixId	text	是	99	结束版本号
sign	text	是		签名
isNeedInvalidData	text	是		是否需要无效部门数据，1-是，将返回无效的部门，0-否，只返回有效的部门

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ list	object	必须
├─ accDepNum	string	必须	部门编号
├─ accDepName	string	必须	部门名称
├─ parentNum	string	必须	父部门编号
├─ parentName	string	必须	父部门名称
├─ fixid	string	必须	数据版本号
├─ recFlag	string	必须	部门有效状态，0-无效，1-有效
├─ sign	string	必须	签名
├─ count	string	必须	部门数量
├─ currentAccDepFixId	string	必须	当前数据中最大版本号

获取所有操作员信息

基本信息

Version： ET_v5.1.20.0630

Path： /api/common/systemdocking/getoperatorinfo?access_token={access_token}

Method： POST

接口描述：

只支持单租户

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	integer	必须	返回状态
data	object	必须
├─ list	object	必须
├─ optName	string	必须	操作员名字
├─ optNum	integer	必须	操作员编号
├─ sign	string	必须	签名
msg	string	非必须	返回信息

版本号变更查询

根据版本号获取卡内编号黑白名单

基本信息

Version： ET_v5.1.20.0531

Path： /api/common/getcardcodechangebyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
fixid	text	是	初始版本号
size	text	是	大小限制
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	易通使用单位编号
├─ accNum	string	必须	账号(35对应的为主账号)
├─ cardCode	string	必须	卡内编号
├─ cardAccNum	string	必须	卡账号
├─ fixid	string	必须	变更版本号
├─ recFlag	string	必须	有效标记 0-无效 1-有效
├─ sign	string	必须	验签

根据版本号获取卡账户身份信息(4.0不实现)

基本信息

Version： ET_v5.1.20.0531,ET_v5.1.20.1130

Path： /api/common/getcardaccclassbyfixid?access_token={access_token}

Method： POST

接口描述：

ET5.1.20.0531版本返回时只包含epId、accNum、cardAccNum、identityId、recflag、fixid六个字段。
ET5.1.20.1130版本增加其他字段返回。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
fixid	text	是	初始版本号
size	text	是	大小限制
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	易通使用单位编号
├─ accNum	string	必须	账号(35对应的为主账号)
├─ cardAccNum	string	必须	卡账号
├─ identityId	string	必须	卡账户身份序号
├─ recflag	string	必须	有效标记 0-无效 1-有效
├─ fixid	string	必须	变更版本号
├─ campusId	string	必须	账户所属园区号
├─ modiTime	string	必须	卡账户身份修改时间格式为“yyyy-MM-dd HH:mm:ss”
├─ accName	string	必须	账户名称
├─ payPwd	string	必须	账户密码(密文)
├─ mainOrVice	string	必须	是否主卡 1-主卡 2-副卡
├─ cardStatus	string	必须	卡状态易通平台：0-销卡 1-有效 2-挂失 3-冻结 4-预销卡 5-锁卡
├─ disableDate	string	必须	账户失效日期：>=本日期不允许交易格式为“yyyy-MM-dd”
├─ perCode	string	必须	个人编号
├─ accdepId	string	必须	账户部门序号。
├─ sex	string	必须	性别 0-未知 1-男 2-女 9-未说明
├─ idType	string	必须	证件类型易通平台： 1-居民身份证 2-护照 3-学生证 4-工作证 5-军官证 6-其他证件 7-台胞证
├─ idNo	string	必须	证件号码
├─ accType	string	必须	身份类别易通平台： 0-临时工 1-博士生 2-研究生 3-本科生 6-普通校务人员 7-工作证 8-离退休卡
├─ workCode	string	必须	工作证号
├─ sequenceNum	string	必须	配卡次数
├─ cardInfoVer	string	必须	卡信息版本号按卡片循环使用取值范围：1~255
├─ sign	string	必须	验签

根据版本号获取补助信息

基本信息

Version： ET_v5.1.20.0531

Path： /api/common/getsubsidypackagebyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
fixid	text	是	初始版本号
size	text	是	大小限制
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	易通使用单位编号
├─ accNum	string	必须	账号(40对应的为主账号)
├─ cardCode	string	必须	卡内编号
├─ ewalletId	string	必须	电子现金钱包号
├─ sidBegin	string	必须	起始补助流水号
├─ sidEnd	string	必须	终止补助流水号
├─ moneySum	string	必须	补助金额(double类型)
├─ fixid	string	必须	变更版本号
├─ sign	string	必须	验签

获取使用单位下所有电子现金钱包参数

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.0531

Path： /api/common/getewalletparembyfixid?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ list	object	必须
├─ epId	string	必须	易通使用单位编号
├─ ewalletId	string	必须	钱包序号
├─ ewalletName	string	必须	钱包名称
├─ ewalletType	string	必须	钱包类型 1-闭环钱包 2-开环钱包 3-专款专用钱包
├─ countType	string	必须	计量类型 1-计额 2-计次
├─ countUnit	string	必须	计量单位 0-元 1-次
├─ takeDepositFee	string	必须	是否收取存款管理费 0-不收取 1-收取
├─ allowReset	string	必须	是否允许余额复位 0-禁用 1-启用
├─ resetLow	string	必须	复位下限 (double类型) 复位到多少金额或次数（正数），不足该金额或次数的不复位。默认复位到0.0
├─ resetMode	string	必须	复位周期模式 1-定期复位 2-周期复位
├─ resetCycle	string	必须	复位周期 1-按年 2-按月 3-按周
├─ restTime	string	必须	复位时间点按年复位:支持4个时间点,以”;”做分割，例如“05-01;10-01” 按月复位：32表示每月最后一天 01表示每月1日按周复位：取值1-7 表示周一到周日
├─ ewalletTranRange	string	必须	允许转出钱包范围“4;9;15;16;18;25”
├─ tiedEwalletId	string	必须	追扣钱包序号
├─ tiedFlag	string	必须	追扣标记
├─ ewalletAttr	string	必须	钱包性质 0：普通钱包 1：计息钱包 2：理财钱包
├─ businessNum	string	必须	商户编号(易通: 使用单位编号*100000+商户序号其他系统:商户编号和商户序号相同)
├─ mainSector	string	必须	正本扇区号 0-15
├─ mainBlock	string	必须	正本块号 0-3
├─ bakSector	string	必须	副本扇区号
├─ bakBlock	string	必须	副本块号
├─ recFlag	string	必须	有效标记0-无效(删除) 1-有效
├─ fixId	string	必须	版本号
├─ count	string	必须	List中的对象数量
├─ maxFixid	string	必须	使用单位电子现金钱包最大版本号
├─ sign	string	必须	验签

获取使用单位下某个最新版本号

基本信息

Version： ET_v5.1.20.0531,ZYTK40_40.20.1130,ET_v5.1.21.0831,ZYTK40_40.21.1031

Path： /api/common/getscparamverepbykey?access_token={access_token}

Method： POST

接口描述：

易通21.0831版本中新增4-地址变更版本号 8-系统参数版本号 9-商户参数版本号 10-钱包参数版本号 11-身份钱包参数版本号 12-易通系统级使用单位变更版本号 13-软密钥参数版本号 14-账户信息变更版本号这八类版本号的获取
ZYTK40 21.1031版本中新增2-补助打包版本号 8-系统参数版本号 9-商户参数版本号 10-钱包参数版本号 11-身份钱包参数版本号 12-ZYTK40系统级园区变更版本号 14-账户信息变更版本号这七类版本号的获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
epId	text	是	易通使用单位编号
fixType	text	是	易通实现：1-卡内编号黑白名单版本号 2-补助打包版本号 3-卡账户身份信息版本号 4-地址变更版本号 8-系统参数版本号 9-商户参数版本号 10-钱包参数版本号 11-身份钱包参数版本号 12-易通系统级使用单位变更版本号 13-软密钥参数版本号 14-账户信息变更版本号
ZYTK4.0实现：1-卡内编号黑白名单版本号 2-补助打包版本号 4-地址变更版本号(废弃) 5-用户住宿信息(废弃) 8-系统参数版本号 9-商户参数版本号 10-钱包参数版本号 11-身份钱包参数版本号 12-ZYTK40系统级园区变更版本号 14-账户信息变更版本号
areaNums	text	是	对接4.0园区号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ fixid	string	必须	参数版本号
├─ sign	string	必须	验签

银行转账

查询可签约银行

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/querysignablebank?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询该用户可签约的银行，该接口需要权限认证。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号，如果不传默认为账户所属单位
accNum	text	是	100	一卡通帐号，可以通过【获取账户信息接口】获得
sign	text	是	QWERWERWETRTRY	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	必须	签名
├─ lsit	object	必须
├─ bankName	string	非必须	银行名称
├─ bankNum	string	非必须	银行编号
├─ bankCardNum	string	必须	银行卡号

查询已签约银行

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/queryenablebank?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询该用户已签约的银行，该接口需要权限认证。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号，不传默认为账户所属单位
accNum	text	是	100	一卡通账号
sign	text	是	QWERWERWETRTRY	签名

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	必须	签名
├─ list	object []	非必须		item 类型: object
├─ bankName	string	非必须	银行名称
├─ bankNum	string	非必须	银行编号
├─ bankCardNum	string	必须	银行卡号

签约银行

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/webapisignbankcard?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口将用户与指定的银行卡进行签约，签约后才可进行银行转账，该接口需要权限认证。
注意：密码必须以加密方式传输。具体加密算法如下：
unencryptedPwd:未加密的密码字符串(明文)
encryptedPwd:加密后的密码字符串(密文)
1.拼接待加密字符串
stringTemp="password=unencryptedPwd&key=appid";
2.MD5加密
encryptedPwd=MD5(stringTemp);
调用该接口时，将encryptedPwd传入"password"参数。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号，不传默认为账户所属单位
accNum	text	是	100	一卡通账号
bankCardNum	text	是	123412341234123	银行卡号，可需要绑定的银行卡号
bankNum	text	是	4	系统支持的银行编号，可以通过【查询可签约银行接口】获得
bankCardType	text	否	1	银行卡类型（1-借记卡；2-信用卡），不传默认为1
password	text	是	6089d0297ebd53d0e9e4fc0c029516e8	交易密码，一卡通密码
sign	text	是	QWERWERWETRTRY	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

获取转账记录

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/getbankrecord?access_token={access_token}

Method： POST

接口描述：

通过一卡通银行转账流水号获取转账记录

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
recNum	text	是	2	一卡通转账流水号

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	必须	签名
├─ list	object []	非必须		item 类型: object
├─ accNum	string	非必须	一卡通账号
├─ cardAccNum	string	非必须	一卡通卡账号
├─ bankCardNum	string	必须	银行卡号
├─ epId	string	非必须	使用单位编号
├─ eWalletId	string	必须	钱包号
├─ bankNum	string	必须	银行编号
├─ clientCode	string	非必须	银行客户号
├─ monTrans	string	必须	转账金额
├─ applyTime	string	必须	申请时间
├─ transTime	string	必须	转账时间
├─ transFlag	string	必须	转账标记，0-待转账，1-转账中，2-转账成功，3-转账失败，4-已补扣，5-待补扣
├─ failedTime	string	必须	失败时间
├─ transType	string	必须	转账类型，1-自动转账，2-自助转账，3-银行对账，4-自动转账(卡转到银行)，5-自助转账(卡转到银行)，6-银行对账(卡转到银行)，7-银行代扣
├─ payRecNum	string	非必须	一卡通交易流水号
├─ checkStatus	string	必须	对账状态，0-未对账，1-对账无误，2-银行多扣，3-银行少扣
├─ checkTime	string	必须	对账时间
├─ bankSID	string	必须	银行方流水号
├─ transInterfaceType	string	非必须	转账发起类型，0-自助服务终端(快捷)，1-银行网站(网银)，2-手机客户端(快捷)，3-门户网站(快捷)，4-银行手机客户端，5-门户网站(网银)，6-自助服务终端(刷卡)，7-银行ATM(POS)，8-空中圈存，9-移动直充

解约银行

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/webapiunsignbankcard?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口将用户与指定的银行卡进行解约，解约后将不能进行银行转账，该接口需要权限认证。
注意：密码必须以加密方式传输。具体加密算法如下：
unencryptedPwd:未加密的密码字符串(明文)
encryptedPwd:加密后的密码字符串(密文)
1.拼接待加密字符串
stringTemp="password=unencryptedPwd&key=appid";
2.MD5加密
encryptedPwd=MD5(stringTemp);
调用该接口时，将encryptedPwd传入"password"参数。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号，不传默认为账户所属单位
accNum	text	是	100	一卡通账号
bankCardNum	text	是	123412341234123	银行卡号，可需要绑定的银行卡号
password	text	是	6089d0297ebd53d0e9e4fc0c029516e8	交易密码，一卡通密码
sign	text	是	QWERWERWETRTRY	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

转账

基本信息

Version： ET_v5.1.20.0930

Path： /api/common/banktransfer/webapibanktransfer?access_token={access_token}

Method： POST

接口描述：

注意：密码必须以加密方式传输。具体加密算法如下：
unencryptedPwd:未加密的密码字符串(明文)
encryptedPwd:加密后的密码字符串(密文)
1.拼接待加密字符串
stringTemp="password=unencryptedPwd&key=appid";
2.MD5加密
encryptedPwd=MD5(stringTemp);
调用该接口时，将encryptedPwd传入"password"参数。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号，不传默认为账户所属单位
accNum	text	是	100	一卡通账号
cardAccNum	text	否	69	一卡通卡账号，40没有卡账号
bankCardNum	text	否	123412341234123	银行卡号，需要绑定的银行卡号，40不需要传银行卡号，易通必传
inEWalletNum	text	否	1	转入钱包号，不传时取默认钱包，40不需要传，默认主钱包；易通必传
monTrans	text	是	0.01	交易金额，格式是XX.XX元
password	text	是	6089d0297ebd53d0e9e4fc0c029516e8	交易密码，一卡通密码
sign	text	是	QWERWERWETRTRY	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	必须
├─ walletName	string	必须	转入钱包名称
├─ walletMoney	string	必须	钱包余额
├─ recNum	string	必须	银行流水号

门禁考勤

第三方考勤流水入库（通用）

基本信息

Version： ET_v5.1.22.0831

Path： /api/common/attendanceservice/insertattendancestream?access_token={access_token}

Method： POST

接口描述：

**--易通v5.1.22.0831 新增接口 **
开发者可以通过该接口上传第三方考勤流水，该接口需要权限认证。
设备编号传控制器编号

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token	3135646566316537653235296A7A8BA60898C934E61455080E4A523D7808C72EEF51AE66533BD9992C319E30E3C6D8	访问令牌

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	7343	一卡通账号
deviceNum	text	是	2508	设备编号，需要提前在易通平台中新增一个考勤设备，记录该设备的设备编号，定义为虚拟考勤设备。
readerNum	text	是	2509	读头编号，虚拟考勤设备下属的读卡器设备编号（来自门禁考勤机读头表）。
ocurrTime	text	是	2018-01-01 11	发生时间，即考勤实际签到时间，格式为 yyyy-mm-dd HH:mm:ss
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
enterType	text	否	0	进门方式，不填默认刷卡，0-刷卡(默认)，1-刷脸，2-虹膜，3-指纹，4-扫码，

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ accNum	string	非必须	一卡通帐号
├─ recNum	string	非必须	新增的考勤事件记录流水号
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】

二维码开门

基本信息

Version： ET_v5.1.20.1130,ZYTK40_40.20.1130

Path： /api/common/attendanceservice/commonqrcodeopendoor?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定用户进行一卡通扫码开门（发送开门命令），该接口需要权限认证。
应用场景： 第三方应用扫描一卡通门禁机上的二维码，获取到二维码字符串后，调用本接口发送开门命令，完成开门。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token	3135646566316537653235296A7A8BA60898C934E61455080E4A523D7808C72EEF51AE66533BD9992C319E30E3C6D8	访问令牌

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	100	一卡通帐号，可以通过【获取账户信息接口】获得
qrCode	text	是	35302E578BFFA6B746A798F794A749EBC6ADEE86407930D,47669	二维码字符串，扫描一卡通门禁机上的二维码获得
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回码
msg	string	必须		返回消息

查询门设备

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/attendanceservice/querydoor?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询易通平台配置的门设备，该接口需要权限认证。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
optNum	text	是	操作员编号，由易通平台创建对应门禁管理分组的操作员分配给第三方
deviceNum	text	是	门禁控制器设备号
sign	text	是	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	非必须
├─ list	object []	非必须		item 类型: object
├─ deviceName	string	非必须	门设备名称
├─ ctrlStatusStr	string	非必须	控制状态
├─ roomName	string	非必须	房间
├─ isLockLinkStr	string	非必须
├─ doorDeviceNum	string	非必须	门设备号
├─ authModeStr	string	非必须	权限模式
├─ doorMachineNum	string	非必须	门号

查询门禁控制器

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/attendanceservice/queryacccontrol?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口查询易通平台配置的门禁控制器，该接口需要权限认证。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
optNum	text	是	操作员编号，由易通平台创建对应门禁管理分组的操作员分配给第三方
deviceName	text	否	设备名称
seqNo	text	否	设备序列号
machineNum	text	否	设备机号
sign	text	是	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须
msg	string	必须
data	object	非必须
├─ sign	string	必须
├─ list	object []	必须		item 类型: object
├─ typeName	string	必须	设备类型	mock: @string
├─ deviceNum	string	必须	设备号
├─ isFireLinkageStr	string	必须	消防联动
├─ acFunctionStr	string	必须	门禁考勤功能类型
├─ deviceName	string	必须	设备名称
├─ seqNo	string	必须	设备序列号
├─ isAntiPassBackStr	string	必须	反潜回控制
├─ roomName	string	必须	房间
├─ campusName	string	必须	园区
├─ placeTypeStr	string	必须	安装场地类别
├─ machineNum	string	必须	设备机号

远程开门

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/attendanceservice/remoteDoor?access_token={access_token}

Method： POST

接口描述：

设备编号传门编号

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token	3135646566316537653235296A7A8BA60898C934E61455080E4A523D7808C72EEF51AE66533BD9992C319E30E3C6D8	访问令牌

Body

参数名称	参数类型	是否必须	示例	备注
optNum	text	是	100001	操作员编号
deviceNum	text	是	10	门编号
sign	text	是	QEWQEQWE234234FR	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		返回码
msg	string	非必须		返回信息

查询门禁权限

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/attendanceservice/queryauth?access_token={access_token}

Method： POST

接口描述：

根据账户查询拥有的进门权限，或者是根据门查询对应的账户权限。
帐号与门编号不能同时为空。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token	3135646566316537653235296A7A8BA60898C934E61455080E4A523D7808C72EEF51AE66533BD9992C319E30E3C6D8	访问令牌

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	否	29211	账号
doorNum	text	否	1521	门编号
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回信息
date	object	必须
├─ sign	string	必须	签名
├─ list	object	必须
├─ accNum	string	必须	帐号
├─ accName	string	必须	账户名称
├─ doorNum	string	必须	门编号
├─ doorName	string	必须	门名称
├─ groupId	string	必须	时段分组编号
├─ groupName	string	必须	时段分组名称
├─ vaildTime	string	必须	生效时间
├─ disableTime	string	必须	失效时间

新增临时进门权限

基本信息

Version： ET_v5.1.22.0331,ET_v5.1.22.0531

Path： /api/common/infoqueryservice/insertTemporaryAuth?access_token={{access_token}}

Method： POST

接口描述：

临时门禁不支持跨单位

权限时间段不可连续，如第一次时间为0100-0200，第二次不可为0200-0300，第二次需改为0201-0300
时间段为0000-2359

每人每设备一天最多六个时段

22.0531新增返回权限信息

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
{access_token

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复
recDate	text	是	2022-03-04	临时门禁权限日期
beginTime	text	是	0030	开始时间段
endTime	text	是	0150	结束时间段
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是	1	使用单位号

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须	返回码
data	object []	非必须		item 类型: object
├─ beginTime	string	非必须	开始时间
├─ deviceNum	number	非必须	设备编号
├─ endTime	string	非必须	结束时间
├─ percode	string	非必须	人员编号
├─ recDate	string	非必须	权限日期
├─ recid	number	非必须	权限记录号，修改删除时需要使用
msg	string	非必须

修改临时进门权限

基本信息

Version： ET_v5.1.22.0331

Path： /api/common/infoqueryservice/updateTemporaryAuth?access_token={{access_token}}

Method： POST

接口描述：

权限时间段不可连续，如第一次时间为0100-0200，第二次不可为0200-0300，第二次需改为0201-0300
时间段为0000-2359

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
{access_token

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复
recDate	text	是	2022-03-04	临时门禁权限日期
beginTime	text	是	0030	开始时间段
endTime	text	是	0150	结束时间段
recId	text	是	1	权限时段记录号
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是	1	使用单位号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回码
msg	string	必须		返回消息

删除临时进门权限

基本信息

Version： ET_v5.1.22.0331

Path： /api/common/infoqueryservice/deleteTemporaryAuth?access_token={{access_token}}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
{access_token

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复
recDate	text	是	2021-10-19	临时门禁权限日期
recId	text	是	1	权限时段记录号
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是		使用单位号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回码
msg	string	必须		返回消息

查询临时进门权限

基本信息

Version： ET_v5.1.22.0331

Path： /api/common/infoqueryservice/queryTemporaryAuth?access_token={{access_token}}

Method： POST

接口描述：

该接口查询参数recDate会查询当日及以后的所有权限
perCode与deviceNums可以同时都传，也可以单独传一个，但不能都不传
单独传perCode会查询该人所有门的权限
单独传deviceNums会查询该门所有人的权限
两个都传会查询该人在该门下的权限

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
{access_token

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号，具体细节请看备注
deviceNums	text	是	1	门设备编号，不能批量，具体细节请看备注
recDate	text	是	2021-10-19	临时门禁时间，会查询出当日及以后所有的权限
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是		使用单位号

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须	返回码
data	object []	非必须		item 类型: object
├─ deviceNum	number	必须	门设备编号
├─ accNum	string	必须	账号
├─ accName	string	必须	账号名称
├─ perCode	string	必须	个人编号
├─ epId	number	必须	使用单位号
├─ beginTime	string	必须	开始时间段
├─ endTime	string	必须	结束时间段
├─ deviceName	string	必须	设备名称
├─ recDate	string	必须	临时门禁权限日期
├─ recId	number	必须	权限时段记录号，修改删除时使用
msg	string	非必须	返回消息

第三方信息导入

删除第三方部门

基本信息

Version： ET_v5.1.21.0831,ET_v8.0.23.0531

Path： /api/common/thirdimportservice/deleteaccdep?access_token={access_token}

Method： POST

接口描述：

通过第三方的部门编号删除账户部门

ET_8.0.23.0531
不支持该接口，第三方需要与用户管理平台对接

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
thirdId	text	是		第三方部门编号
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

增加修改第三方园区

基本信息

Version： ZYTK40_40.20.0930

Path： /api/common/thirdimportservice/uploadarea?access_token={access_token}

Method： POST

接口描述：

第三方园区数据导入，通过第三方的编号去判断是否存在，存在则修改，不存在则新增。（仅支持单园区版）

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token		访问令牌

Body

参数名称	参数类型	是否必须	示例	备注
thirdId	text	是	1	第三方园区编号
parentThirdId	text	是	2	第三方父级园区编号，传0表示顶级
areaName	text	是		园区名称
currentVer	text	是	0	园区当前版本号，没有则传0
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ areaNum	string	必须	一卡通系统园区编号
├─ sign	string	必须	签名

增加修改第三方部门

基本信息

Version： ET_v5.1.21.0630,ET_v8.0.23.0531,ZYTK40_40.20.0930

Path： /api/common/thirdimportservice/uploadaccdep?access_token={access_token}

Method： POST

接口描述：

第三方卡户部门数据导入，通过第三方的编号去判断是否存在，存在则修改，不存在则新增。

ET_8.0.23.0531
不支持该接口，第三方需要与用户管理平台对接

40 20.1130新增该接口，支持单园区，21.0630支持多园区

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
thirdId	text	是	第三方部门编号
parentThirdId	text	是	第三方父级部门编号，0或-1表示顶级
depName	text	是	第三方部门名称
currentVer	text	是	第三方部门版本号，传0默认没有版本号（易通不使用本字段）
epid	text	是	易通的使用单位编号，40为园区编号（单园区传0，多园区传对应的园区编号）
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ depNum	string	必须	一卡通返回的部门编号
├─ sign	string	必须	签名

根据第三方部门编号查询一卡通账户部门

基本信息

Version：

Path： /api/common/thirdimportservice/queryaccdep?access_token={access_token}

Method： POST

接口描述：

第三方卡户信息数据导入，通过第三方的编号查询账户部门信息

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
thirdId	text	是	第三方部门编号
epId	text	是	易通的使用单位编号，40为园区编号（单园区传0，多园区传对应的园区编号）
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
depNum	string	必须	一卡通账户部门编号

第三方应用支付消费接口

第三方应用交易冲正

基本信息

Version： ZYTK40_40.21.0430,ET_v5.1.21.0430

Path： /api/common/thirdappservice/correctorder?access_token={access_token}

Method： POST

接口描述：

此冲正接口只支持冲正一卡通的订单号，如果第三方未记录一卡通订单号的，可通过【第三方应用订单查询】接口获得一卡通订单号

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
correctTransRecId	text	是	一卡通被冲正的订单流水号
transSource	text	是	交易来源，1：一卡通，2：聚合具体由消费接口返回
otherTransRecId	text	是	发起方对接流水号
correctMon	text	否	冲正金额，单位：元。绝对值。默认保留两位小数。不传则全额冲正
oldRecDate	text	否	原单记账日期,格式"yyyy-MM-dd"
dealTime	text	否	交易时间 yyyy-MM-dd HH:mm:ss，注意该交易时间不能早于被冲正单的申请时间
sign	text	是

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ transRecId	string	必须	一卡通冲正订单号（40返回的是交易流水表中的流水号）
├─ correctRecDate	string	必须	冲订单记账日期,格式"yyyy-MM-dd"
├─ uploadTime	string	必须	到账时间 yyyy-MM-dd HH:mm:ss
├─ sign	string	必须	签名
├─ transRecIdQR	string	必须	一卡通冲正订单流水号（40返回的二维码请求表中的订单号）

第三方应用用户二维码交易

基本信息

Version： ZYTK40_40.21.0430,ET_v5.1.21.0430

Path： /api/common/thirdappservice/qrcodetransaction?access_token={access_token}

Method： POST

接口描述：

支持传入一卡通二维码或第三方交易码进行交易

--易通暂不支持优惠、消费管理费计算（一般由第三方系统先调解码接口，自己计算实际交易金额再调该支付解口完成扣款）
--支持匿名交易
--40平台支持优惠、消费管理费的计算策略
-- 20240701（LiuChangchun）增加参数：是否计算管理费和优惠-isCalculateManageFeeAndDiscount，字符类型：1-是，0-否。默认为0(不计算)
--是否计算管理费和优惠-isCalculateManageFeeAndDiscount字符传1时，需要商户启用消费管理费，消费管理费才会生效；如果传0时，商户开启了消费管理费，消费管理费也不会生效
--是否计算管理费和优惠-isCalculateManageFeeAndDiscount字符传1时，需要设备设置接受优惠，优惠才会生效；如果传0时，设备接受了优惠，优惠也不会生效
--是否计算管理费和优惠-isCalculateManageFeeAndDiscount字符传1时，需要设备设置启用消费限次，交易限次才会生效；如果传0时，设备启用了消费限次，消费限次也不会生效；消费冲正后消费限次会冲正
--是否计算管理费和优惠-isCalculateManageFeeAndDiscount字符传1时，需要设备设置启用身份限制，账户身份中身份参数限制（冲正后限制会冲正）：钱包余额上限、日累金额上限、日累次数上限有效，单笔密码限额、日累密码限额无效；如果传0时，设备启用了身份限制，身份参数限制也不会生效
--优惠限次、交易限次、账户身份限制匿名支付下不支持，实名支付下生效
--账户身份限制中日累密码限次针对计次钱包，本接口不支持计次钱包消费
--账户身份限制中日累金额上限只计算交易类型消费和消费冲正的流水的交易金额，不计算消费管理费流水

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
tradeMoney	text	是	1	消费金额,格式是XX.XX元
qrCode	text	是	35302E578BFFA6B746A798F794A749EBC6ADEE86407930D,47669	二维码字符串，扫描用户展示的二维码获得
eWalletId	text	否	1	钱包号，不传的时候，默认以传入设备的工作钱包号为主
dealerNum	text	否	1001	商户编号，不传的时候，默认以传入设备的商户号为主
otherTransRecId	text	是	12121	第三方对接流水号
dealTime	text	是	2021-01-01 13:12:11	交易时间，格式："yyyy-MM-dd HH:mm:ss"
durationID	text	否	1	营业时段号，40用于计算优惠
deviceNum	text	否	1	易通-设备编号或4.0-站点号，40用于计算优惠，钱包号不传的时候，此参数必传
sign	text	否		签名
isCalculateManageFeeAndDiscount	text	否	1	是否计算管理费和优惠，字符类型：1-是，0-否。默认为0(不计算)

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ accNum	string	必须	一卡通帐号
├─ accName	string	非必须	一卡通用户姓名
├─ perCode	string	非必须	人员编号
├─ transRecId	string	必须	一卡通订单流水号，全局唯一
├─ transSource	string	必须	交易来源，1：一卡通，2：聚合易通默认1
├─ amount	string	必须	消费金额,格式是XX.XX元
├─ eWalletBalance	string	非必须	钱包余额,指本次消费卡的钱包余额,格式是XX.XX元
├─ recDate	string	非必须	记账日期 ‘yyyy-MM-dd’，40自主二维码交易无此参数
├─ sign	string	必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
├─ payModel	string	必须	支付渠道1-支付宝2-微信
├─ payModelName	string	必须	支付渠道名称

第三方应用订单查询对账

基本信息

Version： ZYTK40_40.21.0430,ET_v5.1.21.0430

Path： /api/common/thirdappservice/orderquery?access_token={access_token}

Method： POST

接口描述：

当第三方发起对账，如果订单是不成功的状态则去云马查询订单状态，如果云马成功了一卡通执行订单处理流程再次对订单进行处理，如果云马订单不存在或失败则返回失败。

该接口只能查询来自接口调用的订单

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
queryType	text	是	1	订单查询类型 , 传1代表根据一卡通订单号查询,此时transRecId为一卡通订单号 2代表根据开发者流水号查询,此时transRecId为开发者流水号,清算时间必填
transRecId	text	是	123456	标识号
transSource	text	是	1	交易来源，1：一卡通，2：聚合。具体由消费接口返回
recDate	text	否	2020-01-01	记账时间，格式：yyyy-MM-dd（queryType=2时必需）
sign	text	是	QEWQEQWE234234FR	签名

返回数据

名称	类型	是否必须	备注
coed	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ transRecId	string	必须	一卡通订单号
├─ monTrans	string	必须	交易金额。单位：元。若是消费订单，则返回时该金额会带负号。
├─ recTime	string	必须	到账时间 yyyy-mm-dd HH:mm:ss
├─ accNum	string	必须	用户账号
├─ orderStatus	string	必须	订单状态（0：待交易 1：交易成功 2：交易失败3;交易中）
├─ cardAccNum	string	非必须	卡账号
├─ cardCode	string	非必须	卡内编号
├─ sign	string	必须	签名

第三方H5对接

获取H5链接地址

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/thirdh5service/geth5url?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口，获取h5界面的url，该接口需要权限认证。
该接口需要通过调用【获取token】，先获取access_token。
对提交的数据需要提前进行加密，最后只需传入加密的字符串，具体流程如下
1. 调用【获取加密因子接口】获得密钥和偏移量；
2. 拼接参数为指定格式如：jumpMod=homeIndex&uniqueId=103628&queryType=1&epId=&idType=
顺序没有限制

参数名	是否必须	说明
uniqueId	必须	用户标识号(帐号/人员编号/证件号码/手机号）
queryType	必须	账户查询类型（1帐号/2人员编号/3证件号码/4手机号码）
epId	非必须	使用单位号，为0查全部
idType	非必须	证件类型（当查询类型为证件号码时必填，1.居民身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件）
jumpMod	非必须	'homeIndex': 首页，为空默认首页 'recharge': 充值 'rechargeYm':充值，易通请使用这个 'bill': 账单 'itemList': 缴费 'transferWallet': 钱包互转 'reportLoss': 挂失解挂 'balance': 余额查询 'attendRec': 考勤记录 'notice': 通知公告 'pickUpList': 拾卡信息 'waterValveIndex': 生活用水 'virtualCard': 二维码（虚拟卡） 'homeMine': 个人资料 'uploadIDPhoto': 证件照上传 'modifyPassword': 修改登录密码 'uploadAvatar': 人脸认证 'bankCard': 银行卡管理

3. 3DES加密。加密模式：CBC，填充：pkcs5padding，对明文密码进行加密以base64输出(其中字符集均采用UTF-8编码)。
如：
    密钥(key)：459E860199DAD3D74657650D
    偏移量(iv)：053F2244
    待加密内容：jumpMod=homeIndex&uniqueId=103628&queryType=1&epId=&idType=
则：
    加密后的结果为ulhfWDhWJL7stTsEUzB0A0dN2QtCVaDdVaiPK1ABkt7YVS9tkjpogUiHmG/nxjgvUcGslhaWE8HHYV0+A+UY+w==
【注意：1. 密钥(key)为access_token的后24位，偏移量(iv)为appid的后8位；
2. paramcode因为可能会含有特殊符号，有些语言调用接口时报“签名无效”的错误，请尝试对该字段进行urlencode再传输，但是注意一点，拼接待签名内容时不需要urlencode。】

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
paramcode	text	是	ulhfWDhWJL7stTsEUzB0A0dN2QtCVaDdVaiPK1ABkt7YVS9tkjpogUiHmG/nxjgvUcGslhaWE8HHYV0+A+UY+w==	最终只需传入该加密字符串
sign	text	是		签名验证，只对paramcode生成签名，具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ url	string	必须	h5url

信息变更

开户_copy

基本信息

Version： ZYTK40_40.20.0531,ET_v5.1.20.0531

Path： /api/common/infochangeservice/reqopenaccount?access_token={access_token}_1656896433471

Method： POST

接口描述：

该接口，易通平台上需要启用虚拟卡卡种，且对应身份下有虚拟卡卡种参数。另外接口传入的操作员需要分配对应开户身份的操作权限，若不传入操作员，则对应使用单位的默认操作员需要设置身份的操作权限

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号,易通必须传
accName	text	是	张三	账户姓名
idTypeNum	text	是	1	证件类型（1.身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件 7.台胞证）
idNo	text	是	123456	证件号码
perCode	text	否	123	人员编号（不传时，用一卡通默认的个人编号）
sexNum	text	是	1	性别（0.未知 1.男 2.女 9.未说明）
email	text	否	123456@qq.com	电子邮件
joinDate	text	是	20190101	入单位时间，格式必须为YYYYMMDD
disableDate	text	否	20190101	账户失效日期，格式必须为YYYYMMDD（不传以身份失效日期为准）
birthday	text	否	2018-01-01	出生日期
phoneNo	text	否	188XXXXXXXX	手机号
accDepId	text	是	1	账户部门编号
clsNum	text	是	1	账户身份编号（40电力版对应园区身份）
clsNum0	text	否	1	40电力版本必须传（40电力版对应基本身份）
payPassword	text	否	ZgM4FQQlD0g=	交易密码，密文传递，规则参考改密接口,易通需要交易密码与查询密码都传入才会生效，否则生成默认密码
queryPassword	text	否	ZgM4FQQlD0g=	查询密码，密文传递，规则参考改密接口
campusId	text	否	1	园区编号，40园区必须传
optNum	text	否	100001	操作员编号
isOpenAccount	text	否	1	是否开户，0-否，1-是开户开卡，2-仅开户不开卡不填默认为否
cardSid	text	否		原始物理卡号（十进制物理卡号，5-15位，传入时以此卡号开虚拟卡）
cardType	text	否		卡片类型（cardSid不为空时必填，虚拟卡-0、M1卡-1、CPU卡-2、混合卡-8）
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accNum	string	必须	账号
├─ accName	string	非必须	卡户姓名
├─ perCode	string	非必须	个人编号
├─ sexNum	string	非必须	性别编号
├─ accStatusNum	string	非必须	卡户状态
├─ cardAccNum	string	非必须	卡账号
├─ campusId	string	非必须	园区号
├─ clsName	string	非必须	身份名称
├─ clsNum	string	非必须	身份号
├─ accDepName	string	非必须	部门名称
├─ accDepNum	string	非必须	部门号
├─ joinDate	string	非必须	入职日期
├─ disableDate	string	非必须	失效日期
├─ cardAlias	string	非必须	卡别名
├─ cardSid	string	非必须	物理卡号
├─ cardStatusNum	string	非必须	卡状态
├─ balance	string	非必须	钱包余额默认1
├─ eWalletId	string	非必须	钱包号默认主钱包
├─ eWalletName	string	非必须	钱包名称默认主钱包
├─ sign	string	必须

一卡通密码修改

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infochangeservice/updatepwd?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定账户的一卡通密码进行修改，需要一卡通平台开通授权。
注意：原密码和新密码必须以加密方式传输。具体加密算法如下（采用3DES加密）：
1. 调用【获取加密因子接口】获得密钥和偏移量；
2. 3DES加密。加密模式：CBC，填充：pkcs5padding，对明文密码进行加密以base64输出(其中字符集均采用UTF-8编码)。
如：
    密钥(key)=abcdefgh12345678abcdefgh
    偏移量(iv)=12345678
    待加密内容=api
则：
    加密后的结果为eH89ioIVp/Y=
开发者验证算法通过后，再将加密后的密码传入对应参数。

注意：密码参数因为含有加号等特殊符号，有些语言调用接口时报“签名无效”的错误，请尝试对密码字段进行urlencode再传输，但是注意一点，拼接待签名内容时不需要urlencode。如：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	2	一卡通帐号，可以通过【获取账户信息接口】获得。
oriPassword	text	是	ZgM4FQQlD0g=	一卡通原密码
newPassword	text	是	bkNspQ1Rqys=	一卡通新密码
pwdType	text	否	1	密码类型 0:查询密码 1:交易密码（40必须传，易通不用）
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回码
msg	string	必须		返回信息

一卡通强制改密

基本信息

Version： ZYTK40_40.20.0531

Path： /api/common/infochangeservice/forceupdatepwd?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	1	一卡通帐号，可以通过【获取账户信息接口】获得。
newPassword	text	是		一卡通新密码
pwdType	text	否	0	密码类型 0:查询密码 1:交易密码（40必须传，易通不用）
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

上传人脸照片

基本信息

Version： ZYTK40_40.20.0831,ET_v5.1.20.0930

Path： /api/common/infochangeservice/addfacephoto?access_token={access_token}

Method： POST

接口描述：

纯易通SCP5.1环境下，该接口为必须，用于开启人脸对比功能；对接身份核验环境下，人脸照对比功能由身份核验提供，在身份核验处配置

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
accNum	text	是	一卡通帐号，可以通过【获取账户信息接口】获得
facePhoto	text	是	人脸照片，base64格式
sign	text	是	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		接口返回标记，0成功，其他失败
msg	string	必须		返回消息

修改账户基本信息

基本信息

Version： ZYTK40_40.20.0115,ET_v5.1.22.0331

Path： /api/common/infochangeservice/updateaccount?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口修改一卡通指定账户的基本信息，需要一卡通平台开通授权。
智慧一卡通\ZYTK4.0 22.0331 智慧一卡通\ET_v5.1.22.0331 增加参数可以修改账户部门、账户身份
智慧一卡通\ET_v5.1.23.0531 增加人员类别参数
智慧一卡通\ET_v5.1.23.1231 增加人员编号参数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是		一卡通帐号
phoneno	text	否	13500000001	手机号码
accName	text	否	李四	姓名
idType	text	否	1	证件类型，参考数据字典证件类型（idType）
idNo	text	否	330312199911283340	证件号码
sex	text	否	1	性别，参考数据字典性别（sex）
birthday	text	否	19991128	出生日期，日期格式为YYYYMMDD
email	text	否	123456789@qq.com
disableDate	text	否	20200521	失效时间，日期格式为YYYYMMDD （40不支持）
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
accDepId	text	否	1	一卡通部门编号（zytk40 多园区情况下，只能填当前园区的部门编号。）
clsNum	text	否	1	一卡通身份编号
accType	text	否	1	人员类别
perCode	text	否	1	人员编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

冻结账户

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/infochangeservice/freezeaccountcard

Method： POST

接口描述：

一卡通冻结API接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
accNums	text	是	账户	使用英文“,”分割
sign	text	是	eb916d06d8f08a2c4c19bf90be0bf3f6

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须
data	object	非必须
├─ sign	string	非必须
├─ errList	object []	非必须		item 类型: object
├─ accNum	string	非必须	账号
├─ errMsg	string	非必须	返回错误信息
msg	string	非必须

卡片挂失

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infochangeservice/reportloss?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定账户的卡片进行挂失，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
cardAccNum	text	是	2	卡账号，可以通过【获取账户信息接口】获得默认卡片的卡账号或者通过【查询卡片接口】查询出指定卡片的卡账号。40传卡户账号
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码	mock: @string
msg	string	必须	返回消息	mock: @string
data	object	非必须
├─ cardAccNum	string	非必须	卡帐号
├─ cardAlias	string	非必须	卡别名
├─ cardSid	string	非必须	正元物理卡号
├─ cardStatusNum	string	非必须	卡片状态编号，具体查看【数据字典-卡片状态】
├─ mainOrViceNum	string	非必须	主副卡编号，具体查看【数据字典-主副卡】
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

卡片解挂

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infochangeservice/freeloss?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定账户的卡片进行解挂，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
cardAccNum	text	是	2	卡账号，可以通过【获取账户信息接口】获得默认卡片的卡账号或者通过【查询卡片接口】查询出指定卡片的卡账号。
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码	mock: @string
msg	string	必须	返回消息	mock: @string
data	object	非必须
├─ cardAccNum	string	非必须	卡帐号
├─ cardAlias	string	非必须	卡别名
├─ cardSid	string	非必须	正元物理卡号
├─ cardStatusNum	string	非必须	卡片状态编号，具体查看【数据字典-卡片状态】
├─ mainOrViceNum	string	非必须	主副卡编号，具体查看【数据字典-主副卡】
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

一卡通密码验证

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infochangeservice/validatepwd?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定账户的一卡通密码进行验证，需要一卡通平台开通授权。
注意：密码必须以加密方式传输。具体加密算法如下：
unencryptedPwd:未加密的密码字符串(明文)
encryptedPwd:加密后的密码字符串(密文)
1.拼接待加密字符串
stringTemp="password=unencryptedPwd&key=appid";
2.MD5加密
encryptedPwd=MD5(stringTemp);
调用该接口时，将encryptedPwd传入"password"参数。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	2	一卡通帐号，可以通过【获取账户信息接口】获得。
password	text	是	6089d0297ebd53d0e9e4fc0c029516e8	一卡通密码
pwdType	text	否	1	密码类型 0:查询密码 1:交易密码（40必须传，易通不用）
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回码
msg	string	必须		返回信息

开户配卡

基本信息

Version： ZYTK40_40.20.0531,ET_v5.1.20.0531

Path： /api/common/infochangeservice/reqopenaccount?access_token={access_token}

Method： POST

接口描述：

该接口，易通平台上需要启用虚拟卡卡种，且对应身份下有虚拟卡卡种参数。另外接口传入的操作员需要分配对应开户身份的操作权限，若不传入操作员，则对应使用单位的默认操作员需要设置身份的操作权限，该身份在系统参数的外部注册规则中设置
ET_v5.1.23.0531:增加人员类别，为空按外来人员注册规则对应的人员类别开户

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号,易通必须传
accName	text	是	张三	账户姓名
idTypeNum	text	是	1	证件类型（1.身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件 7.台胞证）
idNo	text	是	123456	证件号码
perCode	text	否	123	人员编号（不传时，用一卡通默认的个人编号）
sexNum	text	是	1	性别（0.未知 1.男 2.女 9.未说明）
email	text	否	123456@qq.com	电子邮件
joinDate	text	是	20190101	入单位时间，格式必须为YYYYMMDD
disableDate	text	否	20190101	账户失效日期，格式必须为YYYYMMDD（不传以身份失效日期为准）
birthday	text	否	2018-01-01	出生日期
phoneNo	text	否	188XXXXXXXX	手机号
accDepId	text	否	1	账户部门编号，【易通】不传取系统参数-外部人员注册规则设置的部门
clsNum	text	否	1	账户身份编号（40电力版对应园区身份）。【易通】不传取系统参数-外部人员注册规则设置的身份
clsNum0	text	否	1	40电力版本必须传（40电力版对应基本身份）
payPassword	text	否	ZgM4FQQlD0g=	交易密码，密文传递，规则参考改密接口,易通需要交易密码与查询密码都传入才会生效，否则生成默认密码
queryPassword	text	否	ZgM4FQQlD0g=	查询密码，密文传递，规则参考改密接口
campusId	text	否	1	园区编号，40园区必须传。【易通】不传取系统参数-外部人员注册规则设置的园区
optNum	text	否	100001	操作员编号
isOpenAccount	text	否	1	是否开户，0-否，1-是开户开卡，2-仅开户不开卡不填默认为否
cardSid	text	否		原始物理卡号（十进制物理卡号，5-15位，传入时以此卡号开虚拟卡）
cardType	text	否		卡片类型（cardSid不为空时必填，虚拟卡-0、M1卡-1、CPU卡-2、混合卡-8）
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
accType	text	否	1	人员类别，【易通】不传取系统参数-外部人员注册规则设置的人员类别

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accNum	string	必须	账号
├─ perCode	string	非必须	个人编号
├─ accDepname	string	必须	部门名称
├─ accDepNum	string	必须	部门编号
├─ accName	string	必须	姓名
├─ accStatusNum	string	必须	账户状态
├─ balance	string	必须	钱包余额（默认1）
├─ campusId	string	必须	园区号
├─ cardAccNum	string	必须	卡账号
├─ cardAlias	string	必须	卡别名
├─ cardStatusNum	string	必须	卡状态
├─ cardSid	string	必须	物理卡号
├─ clsName	string	必须	身份名称
├─ clsNum	string	必须	身份编号
├─ disableDate	string	必须	失效日期
├─ ewalletId	string	必须	钱包号
├─ ewalletName	string	必须	钱包名
├─ joinDate	string	必须	入职日期
├─ sexNum	string	必须	性别编号
├─ sign	string	必须	签名

换卡

基本信息

Version： ET_v5.1.21.1231

Path： /api/common/infochangeservice/changecardfornd?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口进行换卡，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
accNum	text	是	一卡通账号
oldCardSid	text	是	老物理卡号（原始物理卡号）
newCardSid	text	是	新物理卡号（原始物理卡号）
cardType	text	是	卡类型（M1卡-1、CPU卡-2、混合卡-8），指的是换的新卡的卡类型
sign	text	是	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

撤户

基本信息

Version： ZYTK40_40.20.0630,ET_v5.1.20.0630

Path： /api/common/infochangeservice/recall?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	1	帐号
optNum	text	否	1001	操作员号
staNum	text	否	1	站点号
preReCallTime	text	是		卡户预撤户时间,格式："yyyy-MM-dd HH:mm:ss"，易通不需要这个字段，传当前时间即可。
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ monReturn	string	必须	退款金额
├─ accStatusNum	string	必须	卡户状态，卡户状态，0撤户 1有效 2挂失 3冻结 4预撤户
├─ recallTime	string	必须	撤户时间，已撤户的返回流水交易时间，格式：yyyy-MM-dd HH:mm:ss
├─ sign	string	必须	签名

获取加密因子

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/infochangeservice/getencryptionfactor?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口获取加密因子，在调用入参或者返回值为密文的接口时使用加密因子信息进行3DES加解密，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ key	string	必须	3DES加密密钥
├─ iv	string	必须	偏移量
├─ sign	string	必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

补卡

基本信息

Version： ET_v5.1.21.1231

Path： /api/common/infochangeservice/retroactivecard?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口进行补卡，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
accNum	text	是	一卡通账号
cardAccNum	text	是	卡账号
newCardSid	text	是	新物理卡号（原始物理卡号）
cardType	text	是	卡类型编号（虚拟卡-0、M1卡-1、CPU卡-2、混合卡-8）
sign	text	是	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

解冻账户

基本信息

Version： ET_v5.1.21.0831

Path： /api/common/infochangeservice/unfreezeaccountcard

Method： POST

接口描述：

一卡通冻结API接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
accNums	text	是	账号	使用英文“,”分割
sign	text	是	签名

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须
data	object	非必须	返回数据
├─ sign	string	非必须	签名
├─ errList	object []	非必须	错误信息列表	item 类型: object
├─ accNum	string	非必须	账号
├─ errMsg	string	非必须	返回错误信息
msg	string	非必须

预撤户

基本信息

Version： ET_v5.1.20.0630,ZYTK40_40.20.0630

Path： /api/common/infochangeservice/prerecall?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	1	帐号
optNum	text	否	1001	操作员
staNum	text	否	1	站点
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accStatusNum	string	必须	卡户状态，卡户状态，0撤户 1有效 2挂失 3冻结 4预撤户
├─ preRecallTime	string	必须	预撤户时间，成功的时候返回，格式：yyyy-MM-dd HH:mm:ss

信息校验

校验该房间在主平台是否存在引用

基本信息

Version： ET_v5.1.20.0531

Path： /api/common/queryroomusestatus

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
roomNum	text	是		房间编号
sign	text	是		验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ status	string	必须	被引用状态 0-未被引用 1-被引用
├─ sign	string	必须	验签

交易冲正

冲正

基本信息

Version： v5.1.20.0115,ZYTK40_40.20.0115

Path： /api/common/payservice/correct?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定交易订单进行冲正，该接口需要权限认证。
注意

该接口冲正用于第三方交易的冲正（预下单模式），不会和聚合支付交互（即钱不会对接到聚合支付）
ZYTK40.20.0731版本支持充值消费部分冲正，及易通5.1.21.0131版本开始支持部分冲正，ZYTK4.0.23.1231支持单消费的部分冲正
易通5.1.21.0630版本支持消费充值类订单冲正
充值类型订单不允许多次冲正，消费和消费充值类允许
易通-账户预销户或冻结状态原充值、消费流水可以冲正，销户后无法冲正会提示“账户不存在”
不支持冲正优惠、消费管理费、存款管理费

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
correctTradeSerial	text	是	一卡通被冲正的订单流水号
tradeOrderNo	text	是	对接平台流水号
注：不是原单的对接平台流水号，是当前冲正新订单对接平台的流水号
correctMon	text	否	冲正金额，不传则全额冲正
recDate	text	是	结账日期,格式"yyyy-MM-dd"
注：结账日期传调用接口时冲正当天的日期，不是原单交易日期
sign	text	是	签名

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ transRecId	string	必须	一卡通冲正订单号
├─ sign	string	必须	签名

订单冲正补账

基本信息

Version： ET_v5.1.20.1130,ZYTK40_40.22.1111

Path： /api/common/payservice/correctcheck?access_token={access_token}

Method： POST

接口描述：

用于处理易通管理web页面上发起的订单冲正，第三方处理成功，但是聚合返回失败的情况。需要聚合调用该接口来处理冲正补账。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	备注
correctTradeSerial	text	是	一卡通传给聚合冲正订单的订单号
tradeOrderNo	text	是	聚合平台流水号
sign	text	是	验签

返回数据

名称	类型	是否必须	备注
code	string	必须	状态码
msg	string	必须	提示信息
data	object	必须
├─ transRecNum	string	必须	一卡通冲正订单号
├─ correctMoney	string	必须	冲正金额
├─ sign	string	必须	验签

支付消费

二维码转账

基本信息

Version： ET_v5.1.20.1130,ZYTK40_40.20.1130

Path： /api/common/payservice/qrcodetransfer?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对两个用户进行余额互转，该接口需要权限认证。
应用场景： 第三方应用扫描一卡通账户二维码，获取到二维码字符串后，调用【一卡通二维码解析】接口进行二维码解析，解析成功后，跳转到转账页面，输入转账金额，点击“转账”按钮时调用本接口完成转账。
注意： 调用方无法获知转入钱包号和转出钱包号时，钱包号默认传1,主钱包。
非同账户间转账存在安全风险，请谨慎使用

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
outAccNum	text	是	100	一卡通帐号（余额转出帐号），可以通过【获取账户信息接口】获得
outWalletNum	text	是	1	转出账户钱包号，调用方无法获得钱包号时传1
inAccNum	text	是	100	转入一卡通账户
inWalletNum	text	是	1	转入账户钱包号，调用方无法获得钱包号时传1
amount	text	是	10.00	转出金额,格式是XX.XX元。
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

聚合支付离线补帐

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/payservice/hzsunpay/offlinepay?access_token={access_token}

Method： POST

接口描述：

本接口不校验余额下限；
如果有优惠，会根据一卡通使用单位系统参数【离线聚合码优惠退还方式】来退还优惠金额至一卡通或者原路返回；
补账过程中不做消费范围控制、消费金额限制，不执行消费管理费策略，但执行消费优惠策略（匿名支付不执行优惠策略）。
补账时的交易时间应为该消费实际发生的时间，到账时间为当前入账时间。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
optType	text	是	1	交易类型 1:充值消费 3:充值 5：消费
uniqueId	text	是		卡户标识号
queryType	text	是	1	卡户标识号类型 1、账号 2、人员编号/个人编号 3、证件号码 4、正元物理卡号 5、原始物理卡号（ ZYTK4.0中，4、5均为卡号） 6、手机号
eWalletNum	text	是	1	交易钱包号，不支持开环钱包（4.0）
monTrans	text	是		交易金额,单位：元
dealerNum	text	是		商户号
dealTime	text	是		交易时间，格式：yyyy-MM-dd HH:mm:ss
proofNum	text	是		对接平台流水号
otherRecId	text	否		支付宝/微信等第三方流水号
recDate	text	是		记账日期
payType	text	是		支付方式：1：支付宝，2：校园卡，3：微信，4：银联，5：云马，6：建行龙支付，7：腾讯微校，8：威富通，9：农业银行，10：翼支付，11：建行e码通，12：招商银行，13：银联商服，14：工行融e联，15：钉钉，16：E福州，17：易校园钱包，18：中行支付，19：光大银行（4.0暂不支持），20：工商银行（易通5.1.21.0630版本新增，4.0暂不支持），21：贵州农信（易通5.1.21.0630版本新增，4.0暂不支持），22：江苏银行（易通5.1.21.0630版本新增，4.0暂不支持），23：柳州银行（易通5.1.21.0831版本新增，4.0暂不支持），24：交通银行（易通5.1.21.0831版本新增，4.0暂不支持），25：济宁银行（易通5.1.21.0831版本新增，4.0暂不支持），26：华融湘江银行（易通5.1.21.0831版本新增，4.0暂不支持）
deviceNum	text	否	1	易通-设备编号或4.0-站点号，用于计算优惠（交易类型为1或5为必填）
durationId	text	否	1	营业时段号，用于计算优惠（交易类型为1或5为必填）
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记，返回0成功，0001失败但可以重试，0002失败无需重试
msg	string	必须	返回信息
data	object	非必须	返回数据集
├─ accNum	string	非必须	卡户帐号
├─ accName	string	非必须	卡户姓名
├─ perCode	string	非必须	卡户个人编号
├─ balance	string	非必须	余额（元）
├─ consumeMgFee	string	非必须	消费管理费（元）
├─ concessionsMon	string	非必须	优惠费用（元）
├─ transRecId	string	非必须	一卡通订单号
├─ proofNum	string	非必须	对接方流水号
├─ monTrans	string	非必须	交易金额（元），与传入参数monTrans一致
├─ actualMonTrans	string	非必须	实际交易金额（元）
├─ sign	string	非必须	签名

获取通用二维码

基本信息

Version： v5.1.20.0331,ZYTK40_40.20.0331

Path： /api/common/payservice/getcommonqrcode?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口获得一卡通的通用消费二维码，该接口需要权限认证。
应用场景： 第三方调用本接口获取二维码字符串之后以二维码形式展现在自己的APP中，由一卡通消费pos机（需支持二维码功能）扫描二维码完成支付。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是	2	一卡通帐号，可以通过【获取账户信息接口】获得
sign	text	是	QWERWERWETRTRY	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ qrCode	string	非必须	二维码字符串
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

订单处理

基本信息

Version： v5.1.20.0115,ZYTK40_40.20.0115

Path： /api/common/payservice/orderhandle?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定预下单后订单进行订单处理，该接口需要权限认证。
注意

该接口需与【预下单】接口配合完成业务流程
预下单交易类型为充值消费时，返回的订单号为消费充值类订单号
预下单为消费类型时，支付方式可以传2，后台默认记为一卡通余额

ET5.1.22.1130版本修改
增加字段isCheckCardStatus，之前版本默认都校验卡状态
v5.1.22.1130改动：增加是否校验卡状态参数（isCheckCardStatus，可空），解决当卡状态为“挂失”时，仍然可以消费问题。

【2023/05/15 方晗】支付渠道增加及版本校对：
支付渠道增加：34：交行数币货币，38：建行数字货币，48：工行数字货币，51：中行数字货币，52：农行数字货币，53：和包支付，54：河北银行，56：工行聚富通，58：江苏农商银行，101：电子券
2023/05/15易通主线版本支持渠道校对：1：支付宝，2：校园卡，3：微信，4：银联，5：云马，6：建行龙支付，8：威富通，9：农业银行，10：翼支付，11：建行e码通，12：招商银行，13：银联商服，14：工行融e联，17：易校园钱包，18：中行支付，20：工商银行，24：交通银行，28：邮储银行，29：中行一码通，32：浙江农信，34：交行数币货币，38：建行数字货币，48：工行数字货币，51：中行数字货币，52：农行数字货币，53：和包支付，54：河北银行，56：工行聚富通，58：江苏农商银行，101：电子券

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
transRecId	text	是		预下单时返回的一卡通订单号
dealTime	text	是		交易时间，格式："yyyy-MM-dd HH:mm:ss"
proofNum	text	是		对接方平台流水号（易通proofNum不超过32位）
otherRecId	text	否		支付宝/微信等第三方流水号
recDate	text	是		记账日期，格式"yyyy-MM-dd"，记账日期传当天交易日期
payType	text	是		支付方式：1：支付宝，2：校园卡，3：微信，4：银联，5：云马，6：建行龙支付，7：腾讯微校，8：威富通，9：农业银行，10：翼支付，11：建行e码通，12：招商银行，13：银联商服，14：工行融e联，15：钉钉，16：E福州，17：易校园钱包，18：中行支付，19：光大银行（4.0暂不支持），20：工商银行（易通5.1.21.0630版本新增，4.0暂不支持），21：贵州农信（易通5.1.21.0630版本新增，4.0暂不支持），22：江苏银行（易通5.1.21.0630版本新增，4.0暂不支持），23：柳州银行（易通5.1.21.0831版本新增，4.0暂不支持），24：交通银行（易通5.1.21.0831版本新增，4.0暂不支持），25：济宁银行（易通5.1.21.0831版本新增，4.0暂不支持），26：华融湘江银行（易通5.1.21.0831版本新增，4.0暂不支持），27：宁波银行（易通5.1.21.0831版本新增，4.0暂不支持），28：邮储银行（易通5.1.21.0831版本新增，4.0暂不支持），29：中行一码通（易通5.1.21.0831版本新增，4.0暂不支持），30：河北农信社支付（易通5.1.21.0831版本新增，4.0暂不支持），31：浙商银行支付，32：浙江农信(易通5.1.22.0615版本新增，4.0暂不支持），34：交行数币货币，38：建行数字货币，48：工行数字货币，51：中行数字货币，52：农行数字货币，53：和包支付，54：河北银行，56：工行聚富通，58：江苏农商银行，101：电子券
openId	text	否	1	如果为空，则默认取token绑定的openId，否则以传入的为主。易通这个参数不用
isDiscount	text	否		该笔交易是否存在第三方渠道优惠（如中行红包） 0-否 1-是，该参数仅在预下单时optType=1的时候才生效
pay_channel	text	否		第三方优惠（如中行红包）支付渠道，isDiscount为1时必需参数，isDiscount为1或空则取payType值，
paytype=2时，pay_channel=29，其他与paytype值相同
channel_discount_amount	text	否		第三方渠道优惠（如中行红包）金额，isDiscount为1时必需参数
sign	text	是		签名
isCheckCardStatus	text	否		是否校验卡状态（挂失）0-否，1-是，默认1-是

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	必须	返回数据集
├─ transRecId	string	必须	一卡通订单号(预下单交易类型为充值消费时返回消费充值订单号)
├─ actualMonTrans	string	非必须	实际交易金额（元），消费类不会返回
├─ balance	string	非必须	钱包余额，40暂无
├─ sign	string	必须	签名

预下单

基本信息

Version： v5.1.20.0115,ZYTK40_40.20.0115

Path： /api/common/payservice/preorder?access_token={access_token}

Method： POST

接口描述：

开发者可以通过该接口对指定用户进行预下单，该接口需要权限认证。
应用场景：
交易类型分别为 1:充值消费 3:充值 5：消费，根据交易类型生成不同订单，交易类型为充值消费时生成一笔消费类和一笔消费充值类订单，返回消费充值类订单号。
场景1
一卡通充值消费：本身有支付能力的第三方通过支付宝或微信或银行等支付渠道直接在一卡通里消费，如第三方通过支付宝为学校提供网上订餐的功能。
场景2
一卡通充值：第三方通过支付宝或微信或银行等支付渠道对学生一卡通余额进行充值。
场景3
一卡通消费：第三方通过学生一卡通余额进行消费。
注意

该接口处理后配合【订单处理】接口完成业务流程
消费支持优惠、消费管理费和追扣，消费时结算商户以传入的商户为主，扣款钱包为设备工作钱包（40不支持追扣）
不支持消费限次
建议交易时间传当天时间，否则优惠限次不起作用
交易类型为3时，需要在平台同时授权“一卡通充值预下单”和“预下单（通用）”接口才可以请求成功，否则提示平台未授权
不支持副卡交易
未配卡的情况下，不支持给电子账户钱包充值；在配卡的情况下钱包可消费，但不支持充值，可使用老接口一卡通充值(在5.1.23.1231版本中已修改：配卡的情况下电子账户钱包允许充值)
易通不支持身份钱包参数的限额和限次，余额下限是受控制的

2024.08.29接口增加跨单位交易记账说明：
1.接口传epid（账户所属单位），商户号传B园区商户，此时记账以商户所属园区为主，所以记账在B园区，A单位和B单位都会记账，但是只有B单位会出报表（因为商户为B园区的）；
-----------------------------------------------------------------------------------------版本改动如下--------------------------------------------------------------------------------

v5.1.21.0831改动：增加账户所属使用单位编号请求参数（epId，可空），解决易通多使用单位版本，人员编号、证件号码、手机号码会重复导致充值出错的问题。
注意：易通单使用单位版本，录入手机号码时没做重复校验，可能会录入多个相同手机号，需人为控制。

v5.1.22.1130改动：增加是否校验卡状态参数（isCheckCardStatus，可空），解决当卡状态为“挂失”时，仍然可以消费问题。

v5.1.23.1231 && v8.0.23.1231改动：当消费或充值消费时，传入的交易时间不在传入的时段号对应的时间段内，将认为传入的时段号无效，不计优惠，流水不记录时段号

v5.1.24.1231 && v8.0.23.1130改动：
1、传"设备编号"、”时段号“时，优先判断交易时间是否在设备所设置的营业分组时段内
交易人为本单位人员

如果在设备的营业时段内则流水中的时段记相应的时段。
如果不在设备的营业时段内则流水中的时段记”非营业时段“
根据设备参数计算优惠、消费限次、账户身份限制
根据商户设置了是否“启用消费管理费”而计算消费管理费
如果所传交易时间非当天时间，也同样需要根据设备参数计算优惠、消费限次、账户身份限制

交易人为外单位人员

允许交易的情况下不计算优惠、消费管理费、交易限次、账户身份策略

2、如果只传了”时段号“，没有传设备编号

如果交易时间在时段号范围内，则流水中的时段记相应的时段。
如果交易时间不在时段号范围内，则流水中的时段记”非营业时段“
无论本单位还是外单位人员，都不计算优惠、消费管理费、交易限次、账户身份策略
根据商户设置了是否“启用消费管理费”而计算消费管理费

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
optType	text	是		交易类型 optType = 1: 消费充值 optType = 3: 充值 optType = 5：消费
epId	text	否	1	账户所属使用单位编号，当是易通多使用单位版本时，通过人员编号或者证件号码或者手机号码查询时需要传（因为易通多使用单位版本人员编号、证件号码、手机号码会重复）
uniqueId	text	是		卡户标识号（依据账户查询 queryType 类型而定）
queryType	text	是	1	账户查询类型（1帐号/2人员编号/3证件号码/4正元物理卡号/5原始物理卡号/6手机号码）
idType	text	否	1	证件类型（当queryType为3时 idType字段为必填项），1-身份证，2-护照，3-学生证，4-工作证，5-军官证，6-其他证件，7-台胞证
eWalletNum	text	是	1	交易钱包号，不支持开环钱包（4.0），易通不支持计次钱包
eWalletNumSource	text	否	1	钱包选用参数，当钱包号和站点号都传的时候。1：用站点的（默认规则）2：用传入的钱包号
feeNum	text	否	100	交易类型，易通用
monTrans	text	是	0.01	交易金额(单位：元)
dealerNum	text	是	1001	商户号，充值传0；1和5交易类型传具体商户号
dealTime	text	是		交易时间，格式："yyyy-MM-dd HH:mm:ss"
deviceNum	text	否	1	易通-设备编号或4.0-站点号，用于计算优惠。注：只有传了此参数时，交易流水里才会记录交易园区
durationId	text	否	1	营业时段号，用于计算优惠
sign	text	是		签名
isCheckCardStatus	text	否		是否校验卡状态（挂失）0-否，1-是，默认1-是卡挂失不允许交易

返回数据

名称	类型	是否必须	备注
code	string	必须	返回标记
msg	string	必须	返回信息
data	object	非必须	返回数据集
├─ accName	string	非必须	卡户姓名
├─ accNum	string	非必须	卡户帐号
├─ perCode	string	非必须	卡户个人编号
├─ balance	string	非必须	余额（元）
├─ consumeMgFee	string	非必须	消费管理费（元）
├─ concessionsMon	string	非必须	优惠费用（元）
├─ monTrans	string	非必须	交易金额（元），与传入参数monTrans一致
├─ recId	string	非必须	预下单流水号(交易类型为充值消费时返回消费充值订单号)
├─ actualMonTrans	string	非必须	实际交易金额（元）
├─ sign	string	非必须	签名

其他

商户营业汇总查询

基本信息

Version： ZYTK40_40.20.1130

Path： /api/common/infoqueryservice/getstatbusiness?access_token={access_token}

Method： POST

接口描述：

默认汇总已日结的流水

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
dealerNums	text	是	1001,1002,1003	需要汇总的商户列表，用‘,’隔开
beginDate	text	是	2020-10-30	汇总起始时间，yyyy-MM-dd
endDate	text	是	2020-10-30	汇总结束时间，yyyy-MM-dd
sign	text	是		签名

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须	签名
├─ list	object	必须
├─ dealerNum	string	必须	商户号
├─ dealerName	string	必须	商户名称
├─ totalConsumMon	string	必须	消费总额
├─ totalDiscountMon	string	必须	优惠总额
├─ totalTimes	string	必须	交易人次

个性化接口

修改账户基本信息for宁波德业科技股份有限公司

基本信息

Version： ET_v5.1.23.0430

Path： /api/common/infochangeservice/updateaccount?access_token={access_token}_1694664349202

Method： POST

接口描述：

开发者可以通过该接口修改一卡通指定账户的基本信息，需要一卡通平台开通授权。
智慧一卡通\ZYTK4.0 22.0331 增加参数可以修改账户部门、账户身份
智慧一卡通\ET_v5.1.23.0531 增加人员类别参数
个性化内容
ET_v5.1.23.0531
webAPI修改账户基本信息接口增加修改必输remark字段；
webAPI修改账户基本信息接口修改birthday作为入职时间、新增JoinDate作为离职日期；
accType人员类别(固定传值2)。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是		一卡通帐号
phoneno	text	否	13500000001	手机号码
accName	text	否	李四	姓名
idType	text	否	1	证件类型，参考数据字典证件类型（idType）
idNo	text	否	330312199911283340	证件号码
sex	text	否	1	性别，参考数据字典性别（sex）
birthday	text	否	20230521	出生日期，日期格式为YYYYMMDD（个性化改为离职日期）
email	text	否	123456789@qq.com
disableDate	text	否	20200521	失效时间，日期格式为YYYYMMDD
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
accDepId	text	否	1	一卡通部门编号（zytk40 多园区情况下，只能填当前园区的部门编号。）
clsNum	text	否	1	一卡通身份编号
accType	text	是	2	人员类别(固定传值2)
remark	text	是	1	个性化字段
JoinDate	text	否	20230521	个性化字段-入职时间,日期格式为YYYYMMDD

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

修改账户基本信息for江山市机关事务局

基本信息

Version： ZYTK40_40.20.0930

Path： /api/common/infochangeservice/updateaccountforZJJS?access_token={access_token}_1666062539407_1702948774189

Method： POST

接口描述：

开发者可以通过该接口修改一卡通指定账户的基本信息，需要一卡通平台开通授权。
智慧一卡通\ZYTK4.0 22.0331 增加参数可以修改账户部门、账户身份
13914-webAPI增加修改账户身份：江山市机关事务局将ZYTK4.0 22.0331webapi修改身份接口webservice上增加。传入账号，修改身份。其他多余的参数给去掉。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是		一卡通帐号
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
clsNum	text	否	1	一卡通身份编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

修改账户基本信息for诸暨技师学院

基本信息

Version： ZYTK40_40.20.0930

Path： /api/common/infochangeservice/updateaccountforZJJS?access_token={access_token}_1666062539407

Method： POST

接口描述：

开发者可以通过该接口修改一卡通指定账户的基本信息，需要一卡通平台开通授权。
智慧一卡通\ZYTK4.0 22.0331 增加参数可以修改账户部门、账户身份
11249-webAPI接口增加修改身份个性化：诸暨技师将ZYTK4.0 22.0331webapi修改身份接口给在诸暨市浬浦中学webservice上增加。传入账号，修改身份。其他多余的参数给去掉。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	是		一卡通帐号
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
clsNum	text	否	1	一卡通身份编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回标记
msg	string	必须		返回信息

商户部门信息查询for10-0237-南京财经大学

基本信息

Version： ET_v5.1.22.0331

Path： /api/common/infoqueryservice/querybusinessdep?access_token={access_token}_1717638800372

Method： POST

接口描述：

个性化接口:14820-webAPI新增获取商户部门接口
开发者可以通过该接口查询商户部门信息，需要一卡通平台开通授权。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
epId	text	否		使用单位编号。单园区情况下不传；多园区情况下根据实际需求传对应值或不传
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ ParentNum	integer	非必须	商户部门父级编号
├─ DepNum	integer	必须	商户部门编号
├─ DepName	string	必须	商户部门名称
├─ totalNum	number	非必须	总条数
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

开户for宁波德业科技股份有限公司

基本信息

Version： ET_v5.1.23.0430

Path： /api/common/infochangeservice/reqopenaccount?access_token={access_token}_1694423466623

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
epId	text	否	1	使用单位编号,易通必须传
accName	text	是	张三	账户姓名
idTypeNum	text	是	1	证件类型（1.身份证 2.护照 3.学生证 4.工作证 5.军官证 6.其他证件 7.台胞证）
idNo	text	是	123456	证件号码
perCode	text	否	123	人员编号（不传时，用一卡通默认的个人编号）
sexNum	text	是	1	性别（0.未知 1.男 2.女 9.未说明）
email	text	否	123456@qq.com	电子邮件
joinDate	text	是	20190101	入单位时间，格式必须为YYYYMMDD
disableDate	text	否	20190101	账户失效日期，格式必须为YYYYMMDD（不传以身份失效日期为准）
birthday	text	否	2018-01-01	出生日期
phoneNo	text	否	188XXXXXXXX	手机号
accDepId	text	否	1	账户部门编号，【易通】不传取系统参数-外部人员注册规则设置的部门
clsNum	text	否	1	账户身份编号（40电力版对应园区身份）。【易通】不传取系统参数-外部人员注册规则设置的身份
clsNum0	text	否	1	40电力版本必须传（40电力版对应基本身份）
payPassword	text	否	ZgM4FQQlD0g=	交易密码，密文传递，规则参考改密接口,易通需要交易密码与查询密码都传入才会生效，否则生成默认密码
queryPassword	text	否	ZgM4FQQlD0g=	查询密码，密文传递，规则参考改密接口
campusId	text	否	1	园区编号，40园区必须传。【易通】不传取系统参数-外部人员注册规则设置的园区
optNum	text	否	100001	操作员编号
isOpenAccount	text	否	1	是否开户，0-否，1-是开户开卡，2-仅开户不开卡不填默认为否
cardSid	text	否		原始物理卡号（十进制物理卡号，5-15位，传入时以此卡号开虚拟卡）
cardType	text	否		卡片类型（cardSid不为空时必填，虚拟卡-0、M1卡-1、CPU卡-2、混合卡-8）
sign	text	是		目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
accType	text	否	1	人员类别，【易通】不传取系统参数-外部人员注册规则设置的人员类别
remark	text	是	1	个性化数据

返回数据

名称	类型	是否必须	备注
code	string	必须
msg	string	必须
data	object	必须
├─ accNum	string	必须	账号
├─ perCode	string	非必须	个人编号
├─ accDepname	string	必须	部门名称
├─ accDepNum	string	必须	部门编号
├─ accName	string	必须	姓名
├─ accStatusNum	string	必须	账户状态
├─ balance	string	必须	钱包余额（默认1）
├─ campusId	string	必须	园区号
├─ cardAccNum	string	必须	卡账号
├─ cardAlias	string	必须	卡别名
├─ cardStatusNum	string	必须	卡状态
├─ cardSid	string	必须	物理卡号
├─ clsName	string	必须	身份名称
├─ clsNum	string	必须	身份编号
├─ disableDate	string	必须	失效日期
├─ ewalletId	string	必须	钱包号
├─ ewalletName	string	必须	钱包名
├─ joinDate	string	必须	入职日期
├─ sexNum	string	必须	性别编号
├─ sign	string	必须	签名

门禁考勤设备信息查询for福建省电力有限公司

基本信息

Version： ZYTK40_40.20.0331

Path： /api/common/infoqueryservice/doorquerydevice?access_token={access_token}_1717119241280

Method： POST

接口描述：

个性化接口：32-0096 福建省电力有限公司\01-需求文档及资料\14761-提供门禁设备查询接口
开发者可以通过该接口查询门禁设备信息
排序方式：主：设备编号升序

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
start	text	是	1	从第几条开始（包含此条）
limit	text	是	20	查询条数
sign	text	是	QEWQEQWE234234FR	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。

返回数据

名称	类型	是否必须	备注	其他信息
code	string	必须	返回码
msg	string	必须	返回消息
data	object	非必须
├─ list	object []	非必须		item 类型: object
├─ deviceNum	string	非必须	设备编码
├─ deviceName	string	非必须	设备名称
├─ totalNum	number	非必须	总条数
├─ count	number	非必须	当前返回条数 BY40.22.1111
├─ sign	string	非必须	目前默认提供MD5算法后续推出SHA DES RSA 具体查看【开始开发-签名指南】。