管理类接口列表

• 下载密钥
• 每日签到
• 心跳
• 每日结算
• 批上送
• 对账文件
• 下载公钥和AID
• 交易明细查询

下载密钥

接口用途

• 中间件提供按钮，可以在设备初始安装时调用此接口，下载主密钥数据。

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/downloadKey

action

• downloadKey

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
password	String	是	密钥下载密码	3DES加密，HEX格式

请求报文举例

{
    "traceNo": "99000009100010101732123",
    "password": "EE16E3C7D5F8610EADDFCD5BA737CBB9"
}

返回参数，易百后台===>中间件

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	原样返回
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
tmk	String	是	易百POS主密钥	3DES加密，HEX格式
tmkCheckValue	String	是	易百POS主密钥校验值	3DES加密，HEX格式,ptlVersion=20180612主密鑰下载时会下发check value
mwTmk	String	是	中间件主密钥	3DES加密，HEX格式
mwTmkCheckValue	String	是	中间件主密钥校验值	3DES加密，HEX格式,ptlVersion=20180612主密鑰下载时会下发check value

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "tmk": "0BC8C201108F19E53D1904F12AD50DF2",
    "mwTmk": "C716E3C7D5F8610EADDFCD5BA737CBB9",
    "tmkCheckValue": "E7958039AE218AE7",
    "mwTmkCheckValue": "138D579A070F2480"
}

每日签到

接口用途

• 中间件定时任务每天凌晨，调用此接口进行签到，与后台同步密钥信息和状态信息。(因签到前还未获得mwMackey，故使用mwTmk签名)

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/signin

action

• signin

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通
posModel	String	是	MIS-POS型号	如门店有用到易百机具即填写相应设备机型例如：G2，如门店未用易百机具即填写收银机型号
request8583	String	否	请求报文HEX	MIS-POS灌其他机构密钥，需要组包并填写该域
posSn	String	否	机器序列号	例如：G8703U12345
curCommuType	String	否	pos连网方式	GPRS，LAN，WIFI，CDMA
simccid	String	否	sim卡号	GPRS和CDMA的必传
netClientIP	String	否	pos本地IP	LAN必传
netGate	String	否	本地网关	LAN必传

请求报文举例

  {
    "traceNo": "99000009100010101732123",
    "posModel": "G2"
  }

返回参数，易百后台===>中间件

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	原样返回
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
merchantName	String	是	商户门店名称
deviceNo	String	否	收银机编号
shopNo	String	否	门店编号
brand	String	是	品牌编号
defaultHeartbeat	Number	是	默认心跳间隔	单位：秒
publicKey	String	是	银联IC卡公钥	HEX格式，用于IC检验
response8583	String	否	返回报文HEX	MIS-POS灌其他机构密钥，后台透传该域
pinKey	String	是	易百POS PIN密钥	使用tmk进行3DES加密，HEX格式，用于卡信息，密码加密，KEY过期时间为本次签到成功即前一次密钥过期
mwMacKey	String	是	中间件MAC密钥	使用mwTmk进行3DES加密，HEX格式，用于中间件报文签名，KEY过期时间为本次签到成功即前一次密钥过期
webPospUrl	String	否	为终端下发请求WEB POSP的地址	用于要为终端变更新的请求地址
posUrl	String	否	MIS-POS的更新地址或目录	如果为空不需要更新，否则需要更新
mwUrl	String	否	中间件的更新地址或目录	如果为空不需要更新，否则需要更新
signBank	String	否	中间件通知MIS-POS作收单行签到	如果为空不需要签到，否则需要根据返回的值进行对应收单行的签到，可选值参考收单机构标识
headPictureList	List<headPicture>	是	广告图片	用于显示在终端顶部
functionList	List<function>	是	终端功能菜单下发
nextHearbeat	Number	是	下次心跳间隔秒数	下次心跳间隔秒数
orgLogInInfos	List<orgLogInInfo>	否	终端对应机构信息列表

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "merchantName": "哈根达斯张杨路店",
    "defaultHeartbeat": 60,
    "publicKey": "9F0605A0000003339F22010BDF05083230313631323331DF060101DF070101DF0281F8CF9FDF46B356378E9AF311B",
    "pinKey": "9D93D15D6A3913AB4151C456A80841EF",
    "mwMacKey": "94365019BBF9CEEAB0DF658E67754A70",
    "posUrl": "http://ebuyweb-posp-test.e-buychina.com/upgrade/pos/G2/20170214/",
    "mwUrl": "http://ebuyweb-posp-test.e-buychina.com/upgrade/mw/G2/20170214/",
    "signBank": "citicCashpay",
    "headPictureList": [
        {
            "displayPicUrl": "",
            "linkUrl": ""
        }
    ],
    "functionList": [
        {
            "iconUrl": "",
            "title": "",
            "action": "",
            "command": "",
            "childrenFunc": [
                {
                    "iconUrl": "",
                    "title": "",
                    "action": "",
                    "command": ""
                }
            ]
        }
    ]
}

心跳

接口用途

• 中间件定时与易百后台进行通讯，上报当前状态并同步后台服务器状态，通过后台返回的指令调用相应的接口。

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/heartbeat

action

• heartbeat

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transTimestamp	List<transTimestamp>	是	交易时间戳	用于统计每笔交易的耗时
businessType	int	否	心跳类型	0：外卖类； 1：其他类（供可扩展使用）

请求报文举例

  {
    "traceNo": "HB99000009100010101732123",
    "transTimestamp": [
      {
        "traceNo":"99000009100010101732123",
        "send":"1483372334",
        "recv":"1483372335"
      },
      {
        "traceNo":"99000009100010101732125",
        "send":"1483372336",
        "recv":"1483372337"
      }
    ],
    "businessType":0
  }

返回参数，易百后台===>中间件

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	原样返回
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
nextHeartbeat	Number	是	下次心跳间隔秒数
invokeAction	String	否	调用的接口action	如:signin 会在当日重新签到
alertMessage	String	否	提示信息	中间件弹出窗体提示这里返回的信息
businessOrderCount	int	否	未处理订单总数	用于外卖平台，获取最新未处理订单的总数

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "nextHeartbeat": 10,
    "invokeAction": "signin",
    "alertMessage": ""，
    "businessOrderCount":10
}

每日结算

接口用途

• 汇总本次结算至上次结算时间段内的所有成功交易（含退款）。

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/summary

action

• summary

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通

请求报文举例

{
    "traceNo": "99000009100010101732123"
}

返回参数，易百后台===>中间件

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
settleRecord	List<settleRecord>	是	结算记录
beginDate	String	是	结算开始时间	格式：yyyyMMddHHmmss
endDate	String	是	结算结束时间	格式：yyyyMMddHHmmss
volume	Integer	是	总交易笔数
totalReceiptAmount	Price	是	商户实收总金额
totalAmount	Price	是	总金额	所有交易汇总的金额

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "settleRecord": [
        {
            "activityNo": "2016101201",
            "activityName": "浦发银行积分兑换",
            "productName": "大杯",
            "customer": "浦发银行",
            "isRefund": false,
            "volume": 130,
            "totalReceiptAmount": "2082.10",
            "totalAmount": "2082.10"
        },
        {
            "activityNo": "2016120301",
            "activityName": "支付宝",
            "productName": "全场产品",
            "customer": "易百支付",
            "isRefund": false,
            "volume": 100,
            "totalReceiptAmount": "234.10",
            "totalAmount": "234.10"
        }
    ],
    "beginDate": "20161029113602",
    "endDate": "20161030113602",
    "volume": 230,
    "totalReceiptAmount": 1900,
    "totalAmount": 2000,
}

批上送

接口用途

• 收银机可批量上传数据到易百后台，易百后台返回对账匹配的结果，最多支持一周内(含当天)的交易对账。

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchUpload

action

• batchUpload

请求参数，收银机===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transCount	Integer	是	本次上送笔数	必须与transRecord的List大小一致
beginTime	String	是	交易开始时间	格式：yyyyMMddHHmmss
endTime	String	是	交易结束时间	格式：yyyyMMddHHmmss
transRecord	List<transRecord>	是	交易记录	每次上送最大支持5000笔交易

请求报文举例

{
    "traceNo": "99000009100010101732123",
    "transCount": 3,
    "beginTime": "20161231102201",
    "endTime": "20161231102230",
    "transRecord": [
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 100.00,
          "status": 0
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 200.00,
          "status": 0
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 300.00,
          "status": 0
      }
    ]
}

返回参数，易百后台===>收银机

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
transRecord	List<transRecord>	是	对账后的记录	每次返回最大支持5000笔交易

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "transRecord": [
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 100.00,
          "status": 1
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 200.00,
          "status": 2
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 300.00,
          "status": 3
      }
    ]
}

对账文件

接口用途

• TODO

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reconcilliation

action

• reconcilliation

下载公钥和AID

接口用途

• 当终端要操作芯片卡时，需要调用此接口获取aid,ca public key接口最好是在签到后调用

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/downloadAidAndPublicKey

action

• downloadAidAndPublicKey

请求参数，中间件===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列

请求报文举例

{
    "traceNo": "99000009100010101732123"
}

返回参数，易百后台===>中间件

字段	类型	是否必填	字段意义	备注
traceNo	String	是	请求流水号	原样返回
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
aid	String	是	aid	HEX格式
publicKey	String	是	ca public key	HEX格式

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "aid": "0BC8C201108F19E53D1904F12AD50DF2",
    "publicKey": "C716E3C7D5F8610EADDFCD5BA737CBB9"
}

交易明细查询

接口用途

• 查询自最近一次结算成功时间至当前时间的交易信息

接口地址

• https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/getTransList

action

• getTransList

请求参数，收银机===>易百后台

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTid	String	否	线上对接使用的统一终端号	对接前需提前和易百技术沟通
pageSize	Integer	是	页大小	每一页的交易数据条数
pageNo	Integer	是	页数	查看的第几页数据，0为最后一页
printOnly	Integer	否	仅打印	不送：默认无特殊处理，0：去除printDetail，1：保留printDetail去除list类字段

请求报文举例

{
    "traceNo": "99000009100010101732123",
    "pageSize": 2,
    "pageNo": 19
}

返回参数，易百后台===>收银机

字段	类型	是否必填	字段意义	备注
traceNo	String	是	收银机流水号	必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDate	String	是	交易时间	格式为：yyyyMMddHHmmss
returnCode	String	是	返回码	00表示交易成功，其他表示失败
returnDesc	String	是	返回信息	交易结果描述或错误原因
pageNo	Integer	是	页数	当前数据所在页数
count	Integer	是	总记录数	总记录数
pages	Integer	是	总页数	总页数
beginDate	String	是	最近一次结算成功时间	格式:yyyy-MM-dd HH:mm:ss
endDate	String	是	查询记录段结束时间	一般就为当前查询操作时间 格式:yyyy-MM-dd HH:mm:ss
transInfo	List<transInfo>	是	交易记录列表

返回报文举例

{
    "traceNo": "99000009100010101732123",
    "transDate": "20161029113602",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "pageNo": 19,
    "count": 200,
    "pages": 10,
    "beginDate": "2016-10-29 11:36:02",
    "endDate": "2016-10-30 11:36:02",
    "transInfo": [
        {
            "action": "qrcodeSale",
            "traceNo": "20161029113602000001",
            "orderNo": "174098367866",
            "transDate": "20161029113602",
            "returnCode": "00",
            "returnDesc": "SUCCESS",
            "paidAmount": "12.00",
            "activityProductNo": "00000000048398",
            "activityProductName": "微信被扫支付全场通兑产品",
            "bank": "weixinQrpay",
            "cardNo64": "134561********4384",
            "printContent": "00|支付渠道:微信被扫支付|00|支付金额:12.00元|00|优惠折扣:0.10元|00|商户折扣:0.20元|00|顾客支付金额:11.70元|00|NO.4008862001201612233704250176|99|99001675171581028647201612232014080102000000000001|00|*如需退货需凭此小票及小票上二维码,请保留小票"
        },
        {
            "action": "qrcodeSale",
            "traceNo": "20161029113602000001",
            "orderNo": "174098367866",
            "transDate": "20161029113602",
            "returnCode": "00",
            "returnDesc": "SUCCESS",
            "paidAmount": "2082.10",
            "activityProductNo": "00000000048398",
            "activityProductName": "微信被扫支付全场通兑产品",
            "bank": "weixinQrpay",
            "cardNo64": "134562********4387",
            "printContent": "00|支付渠道:微信被扫支付|00|支付金额:2082.10元|00|优惠折扣:0.00元|00|商户折扣:0.00元|00|顾客支付金额:2082.10元|00|NO.4008862001201612233704250176|99|99001675171581028647201612232014080102000000000001|00|*如需退货需凭此小票及小票上二维码,请保留小票"
        }
    ]
}