接口详细文档

本版替换原摘要版，按接口逐条展开；密钥、token、正式地址和生产数据不写入文档。

接口目录

接口详细定义

交易冲正

1. POST /api/common/payservice/correct - 冲正

开发者可以通过该接口对指定交易订单进行冲正，该接口需要权限认证。
注意
该接口冲正用于第三方交易的冲正（预下单模式）
20.0731版本开始支持部分冲正
易通5.1.21.0630版本支持消费充值类订单冲正

Version: v5.1.20.0115,ZYTK40_40.20.0115

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

信息变更

2. POST /api/common/infochangeservice/addfacephoto - 上传人脸照片

Version: ZYTK40_40.20.0831,ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

3. POST /api/common/infochangeservice/forceupdatepwd - 一卡通强制改密

Version: ZYTK40_40.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

4. POST /api/common/infochangeservice/freeloss - 卡片解挂

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

5. POST /api/common/infochangeservice/freezeaccountcard - 冻结账户

一卡通冻结API接口

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

6. POST /api/common/infochangeservice/getencryptionfactor - 获取加密因子

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

7. POST /api/common/infochangeservice/prerecall - 预撤户

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

8. POST /api/common/infochangeservice/recall - 撤户

Version: ZYTK40_40.20.0630,ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

9. POST /api/common/infochangeservice/reportloss - 卡片挂失

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

10. POST /api/common/infochangeservice/reqopenaccount - 开户

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

Version: ZYTK40_40.20.0531,ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

11. POST /api/common/infochangeservice/unfreezeaccountcard - 解冻账户

一卡通冻结API接口

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

12. POST /api/common/infochangeservice/updateaccount - 修改账户基本信息

开发者可以通过该接口修改一卡通指定账户的基本信息，需要一卡通平台开通授权。

Version: v5.1.20.0115,ZYTK40_40.20.0115

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

13. POST /api/common/infochangeservice/updatepwd - 一卡通密码修改

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

14. POST /api/common/infochangeservice/validatepwd - 一卡通密码验证

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

信息查询

15. POST /api/common/getaccclassbycardaccnum - 获取卡账户信息

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

16. POST /api/common/getaccclassewalletparam - 获取身份钱包参数

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

17. POST /api/common/getbusinessbyepid - 获取使用单位下所有商户信息

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

18. POST /api/common/getmaincard - 批量查询账户主卡信息

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

19. POST /api/common/getsystemparambyfixid - 获取使用单位系统参数

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

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

20. POST /api/common/getymuserbycode - 获取云马平台账户信息（通过code）

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

21. POST /api/common/getymuserbyuserid - 获取云马平台账户信息（通过UserID）

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

22. POST /api/common/infoqueryservice/getaccount - 获取账户信息

开发者可以通过该接口获取指定账户信息以及相关附带信息（第一张主卡信息和第一张主卡默认电子现金钱包信息），需要一卡通平台开通授权
注意：
当一卡通账户没有配主卡时，返回的第一张主卡信息和第一张主卡默认电子现金钱包信息全为空字符串。
两种物理卡号的区别。
原始物理卡号：遵循业界规范的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:'',...}"

Version: v5.1.20.0115,ZYTK40_40.20.0115

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

23. POST /api/common/infoqueryservice/getagentidandclientid - 一卡通查询代理号与客户号

Version: ET_v5.1.20.0731,ZYTK40_40.20.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

24. POST /api/common/infoqueryservice/getallowtransepids - 查询允许交易的使用单位

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

Version: ET_v5.1.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

25. POST /api/common/infoqueryservice/getanonymousparam - 获取匿名支付参数信息

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

26. POST /api/common/infoqueryservice/getewallet - 获取钱包余额

Version: ET_v5.1.20.0531,ZYTK40_40.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

27. POST /api/common/infoqueryservice/parseqrcode - 一卡通二维码解析

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

Version: ET_v5.1.20.0531,ZYTK40_40.20.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

28. POST /api/common/infoqueryservice/queryacceventrecord - 门禁流水查询

Version: ZYTK40_40.20.0731,ET_v5.1.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

29. POST /api/common/infoqueryservice/queryaccount - 账户信息查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

30. POST /api/common/infoqueryservice/queryaccwalletsum - 卡户钱包累计优惠次数&金额查询

Version: ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

31. POST /api/common/infoqueryservice/querybusiness - 商户信息查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

32. POST /api/common/infoqueryservice/querydep - 部门信息查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

33. POST /api/common/infoqueryservice/querydevice - 设备信息查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

34. POST /api/common/infoqueryservice/querynotice - 公告查询

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

Version: ZYTK40_40.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

35. POST /api/common/infoqueryservice/queryphoto - 证件照信息查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

36. POST /api/common/infoqueryservice/querystrategy - 一卡通交易策略查询

40.20.0731版本接口只有优惠策略参数返回（list）,
chargefeelist将在后续版本中加入

Version: ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

37. POST /api/common/infoqueryservice/querythirdpaymentbook - 第三方交易流水查询

4.0云马第三方对账查流水用，易通原查流水接口已满足

Version: ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

38. POST /api/common/infoqueryservice/querytransaction - 交易流水查询

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

39. POST /api/common/operator/querylocation - 获取操作员办公场所(易通)

Version: ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

40. POST /api/common/operator/querypermissions - 获取操作员权限列表

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

41. POST /api/common/payservice/orderquery - 订单查询

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

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

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

42. POST /api/common/queryaccclass - 查询使用单位下的身份信息

Version: ZYTK40_40.20.0731,ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

43. POST /api/common/queryaccdeptree - 查询使用单位下账户部门树

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

44. POST /api/common/queryaccountinfo - 查询账户信息

接口入参逻辑：
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-挂失”状态

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

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

45. POST /api/common/queryaccountlist - 查询账户列表(带分页)

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

46. POST /api/common/queryallaccclassbyaccnum - 查询账户下主卡的卡账户身份信息

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

47. POST /api/common/querybusiness - 查询单商户信息(根据商户编号)

Version: ZYTK40_40.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

48. POST /api/common/querycampuse - 查询使用单位园区列表(易通单位下园区)

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

49. POST /api/common/querydevicemaker - 查询厂家信息

Version: ZYTK40_40.20.0731,ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

50. POST /api/common/querydevicesupplier - 查询设备发行方信息

Version: ZYTK40_40.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

51. POST /api/common/queryewallet - 查询使用单位电子现金钱包列表

Version: ZYTK40_40.20.0731,ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

52. POST /api/common/queryewalletsbyaccnum - 查询账户在使用单位下的首张主卡对应的钱包余额信息

查询账户在指定单位下的主卡钱包余额及可用额度信息
入参中商户编号存在时，需判断商户是否为有效商户。
在线钱包余额(本次可用钱包额度) = (卡余额+待领补助金额) 与 库余额 比较，以小为准。
单钱包时实际可用额度 = 在线钱包余额 - 身份钱包余额下限;
有追扣时实际可用额度 = (主钱包在线钱包余额 - 主钱包身份钱包余额下限) + (追扣钱包在线钱包余额 - 追扣钱包身份钱包余额下限) ;
某个钱包的在线钱包余额- 该钱包的身份钱包余额下限 <= 0 时，直接按0计算。
注：接入易通平台时，若该接口的入参中不含商户号，则不进行追扣钱包的相关处理，因为易通商户可以设置是否允许追扣，无商户号时无法判断追扣情况。
** 接入4.0平台时，无需根据商户号判断是否追扣。**

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

53. POST /api/common/queryoperatortree - 查询使用单位下操作员树

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

54. POST /api/common/querysubsidybyaccnums - 查询账户下主卡所有未领补助

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

55. POST /api/common/querytransactiontype - 查询页面交易类型列表

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

Version: ET_v5.1.20.0531,ZYTK40_40.20.0731

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

信息校验

56. POST /api/common/queryroomusestatus - 校验该房间在主平台是否存在引用

Version: ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

其他

57. POST /api/common/infoqueryservice/getstatbusiness - 商户营业汇总查询

默认汇总已日结的流水

Version: ZYTK40_40.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

58. POST /api/common/systemdocking/updateaccroompower - 批量变更进出权限

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

基础认证

59. GET /api/token - 获取 access token

通过 AppID 和 AppSecret 获取 access_token。access_token 有有效期，建议由中控服务器统一刷新和缓存。

200

application/json

成功或错误返回

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string"
    },
    "expires_in": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "msg": {
      "type": "string"
    }
  }
}

支付消费

60. POST /api/common/payservice/getcommonqrcode - 获取通用二维码

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

61. POST /api/common/payservice/hzsunpay/offlinepay - 聚合支付离线补帐

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

Version: v5.1.20.0331,ZYTK40_40.20.0331

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

62. POST /api/common/payservice/orderhandle - 订单处理

开发者可以通过该接口对指定预下单后订单进行订单处理，该接口需要权限认证。
注意
该接口需与【预下单】接口配合完成业务流程
预下单交易类型为充值消费时，返回的订单号为消费充值类订单号
预下单为消费类型时，支付方式可以传2，后台默认记为一卡通余额

Version: v5.1.20.0115,ZYTK40_40.20.0115

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

63. POST /api/common/payservice/preorder - 预下单

开发者可以通过该接口对指定用户进行预下单，该接口需要权限认证。
应用场景：
交易类型分别为 1:充值消费 3:充值 5：消费，根据交易类型 生成不同订单，交易类型为充值消费时生成一笔消费类和一笔消费充值类订单，返回消费充值类订单号。
场景1
一卡通充值消费：本身有支付能力的第三方通过支付宝或微信或银行等支付渠道直接在一卡通里消费，如第三方通过支付宝为学校提供网上订餐的功能。
场景2
一卡通充值：第三方通过支付宝或微信或银行等支付渠道对学生一卡通余额进行充值。
场景3
一卡通消费：第三方通过学生一卡通余额进行消费。
注意
该接口处理后配合【订单处理】接口完成业务流程
v5.1.21.0831改动：增加账户所属使用单位编号请求参数（epId，可空），解决易通多使用单位版本，人员编号、证件号码、手机号码会重复导致充值出错的问题。
注意：易通单使用单位版本，录入手机号码时没做重复校验，可能会录入多个相同手机号，需人为控制。

Version: v5.1.20.0115,ZYTK40_40.20.0115

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

64. POST /api/common/payservice/qrcodetransfer - 二维码转账

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

Version: ET_v5.1.20.1130,ZYTK40_40.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

版本号变更查询

65. POST /api/common/getcardaccclassbyfixid - 根据版本号获取卡账户身份信息(4.0不实现)

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

Version: ET_v5.1.20.0531,ET_v5.1.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

66. POST /api/common/getcardcodechangebyfixid - 根据版本号获取卡内编号黑白名单

Version: ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

67. POST /api/common/getewalletparembyfixid - 获取使用单位下所有电子现金钱包参数

Version: ET_v5.1.20.0531,ZYTK40_40.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

68. POST /api/common/getscparamverepbykey - 获取使用单位下某个最新版本号

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

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

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

69. POST /api/common/getsubsidypackagebyfixid - 根据版本号获取补助信息

Version: ET_v5.1.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

第三方H5对接

70. POST /api/common/thirdh5service/geth5url - 获取H5链接地址

开发者可以通过该接口，获取h5界面的url，该接口需要权限认证。
该接口需要通过调用【获取token】，先获取access_token。
对提交的数据需要提前进行加密，最后只需传入加密的字符串，具体流程如下
1. 调用【获取加密因子接口】获得密钥和偏移量；
2. 拼接参数为指定格式如：jumpMod=homeIndex&uniqueId=103628&queryType=1&epId=&idType=
顺序没有限制
3. 3DES加密。加密模式：CBC，填充：pkcs5padding，对明文密码进行加密以base64输出(其中字符集均采用UTF-8编码)。
如：
密钥(key)：459E860199DAD3D74657650D
偏移量(iv)：053F2244
待加密内容：jumpMod=homeIndex&uniqueId=103628&queryType=1&epId=&idType=
则：
加密后的结果为ulhfWDhWJL7stTsEUzB0A0dN2QtCVaDdVaiPK1ABkt7YVS9tkjpogUiHmG/nxjgvUcGslhaWE8HHYV0+A+UY+w==

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

第三方信息导入

71. POST /api/common/thirdimportservice/deleteaccdep - 删除第三方部门

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

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

72. POST /api/common/thirdimportservice/uploadaccdep - 增加修改第三方部门

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

Version: ET_v5.1.21.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

第三方应用支付消费接口

73. POST /api/common/thirdappservice/correctorder - 第三方应用交易冲正

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

Version: ZYTK40_40.21.0430,ET_v5.1.21.0430

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

74. POST /api/common/thirdappservice/orderquery - 第三方应用订单查询对账

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

Version: ZYTK40_40.21.0430,ET_v5.1.21.0430

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

75. POST /api/common/thirdappservice/qrcodetransaction - 第三方应用用户二维码交易

支持传入一卡通二维码或第三方交易码进行交易
--易通21.0430暂不支持优惠计算
--支持匿名交易

Version: ZYTK40_40.21.0430,ET_v5.1.21.0430

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

系统对接

76. POST /api/common/systemdocking/getaccdepfixid - 获取部门信息当前版本号

Version: ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

77. POST /api/common/systemdocking/getaccdepinfobyfixid - 根据版本号获取部门信息

Version: ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

78. POST /api/common/systemdocking/getaccdoorrecordsbyfixid - 获取人员进出新增记录

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

79. POST /api/common/systemdocking/getaccdoorrecordsfixid - 获取指定门的人员进出记录当前版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

80. POST /api/common/systemdocking/getaccfixid - 获取卡户信息当前版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

81. POST /api/common/systemdocking/getaccinfobyfixid - 根据版本号获取账户信息

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

82. POST /api/common/systemdocking/getaccphotobyfixid - 根据版本号获取账户证件照/人脸照片

Version: ET_v5.1.20.0531,ZYTK40_40.20.0531

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

83. POST /api/common/systemdocking/getaccphotofixid - 获取账户证件照/人脸当前版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

84. POST /api/common/systemdocking/getaccroominfobyfixid - 根据版本号获取第三方对接账户住宿信息

Version: ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

85. POST /api/common/systemdocking/getaccroominfofixid - 获取第三方对接账户住宿信息版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

86. POST /api/common/systemdocking/getapartmentinfobyfixid - 根据版本号获取第三方对接公寓房间信息

Version: ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

87. POST /api/common/systemdocking/getapartmentinfofixid - 获取第三方对接公寓房间信息版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

88. POST /api/common/systemdocking/getdoorpowerfixid - 获取第三方对接进出权限版本号

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

89. POST /api/common/systemdocking/getoperatorinfo - 获取所有操作员信息

Version: ET_v5.1.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

90. POST /api/common/systemdocking/updateaccroom - 更新账户住宿信息

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

91. POST /api/common/systemdocking/updateapartmentinfo - 更新公寓房间信息

Version: ET_v5.1.20.0630,ZYTK40_40.20.0630

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

银行转账

92. POST /api/common/banktransfer/getbankrecord - 获取转账记录

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

93. POST /api/common/banktransfer/queryenablebank - 查询已签约银行

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

94. POST /api/common/banktransfer/querysignablebank - 查询可签约银行

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

95. POST /api/common/banktransfer/webapibanktransfer - 转账

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

96. POST /api/common/banktransfer/webapisignbankcard - 签约银行

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

97. POST /api/common/banktransfer/webapiunsignbankcard - 解约银行

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

Version: ET_v5.1.20.0930

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

门禁考勤

98. POST /api/common/attendanceservice/commonqrcodeopendoor - 二维码开门

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

Version: ET_v5.1.20.1130,ZYTK40_40.20.1130

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

99. POST /api/common/attendanceservice/queryacccontrol - 查询门禁控制器

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

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

100. POST /api/common/attendanceservice/queryauth - 查询门禁权限

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

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

101. POST /api/common/attendanceservice/querydoor - 查询门设备

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

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}

102. POST /api/common/attendanceservice/remoteDoor - 远程开门

Version: ET_v5.1.21.0831

200

application/json

接口返回，字段详见原接口文档

{
  "$ref": "#/components/schemas/CommonResponse"
}