# 管理类接口列表 # 下载密钥 #### **接口用途** - 中间件提供按钮，可以在设备初始安装时调用此接口，下载主密钥数据。 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/downloadKey` #### **action** - `downloadKey` **请求参数，中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString是请求流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
passwordString是密钥下载密码3DES加密，HEX格式
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "password": "EE16E3C7D5F8610EADDFCD5BA737CBB9" } ``` **返回参数，易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString是请求流水号原样返回
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
tmkString是易百POS主密钥3DES加密，HEX格式
tmkCheckValueString是易百POS主密钥校验值3DES加密，HEX格式,ptlVersion=20180612主密鑰下载时会下发check value
mwTmkString是中间件主密钥3DES加密，HEX格式
mwTmkCheckValueString是中间件主密钥校验值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` **请求参数，中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString是请求流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString否线上对接使用的统一终端号对接前需提前和易百技术沟通
posModelString是[MIS-POS](https://book.e-buy.com/link/104#bkmrk-mis-pos "安装于商户门店内的POS机具，提供活动执行辅助及兑换功能")型号如门店有用到易百机具即填写相应设备机型例如：G2，如门店未用易百机具即填写收银机型号
request8583String否请求报文HEX[MIS-POS](https://book.e-buy.com/link/104#bkmrk-mis-pos "安装于商户门店内的POS机具，提供活动执行辅助及兑换功能")灌其他机构密钥，需要组包并填写该域
posSnString否机器序列号例如：G8703U12345
curCommuTypeString否pos连网方式GPRS，LAN，WIFI，CDMA
simccidString否sim卡号GPRS和CDMA的必传
netClientIPString否pos本地IPLAN必传
netGateString否本地网关LAN必传
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "posModel": "G2" } ``` **返回参数，易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString是请求流水号原样返回
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
merchantNameString是商户门店名称
deviceNoString否收银机编号
shopNoString否门店编号
brandString是品牌编号
defaultHeartbeatNumber是默认心跳间隔单位：秒
publicKeyString是银联IC卡公钥HEX格式，用于IC检验
response8583String否返回报文HEX[MIS-POS](https://book.e-buy.com/link/104#bkmrk-mis-pos "安装于商户门店内的POS机具，提供活动执行辅助及兑换功能")灌其他机构密钥，后台透传该域
pinKeyString是易百POS PIN密钥使用[tmk](https://book.e-buy.com/books/e-buy-B6z/page/2b449 "tmk")进行3DES加密，HEX格式，用于卡信息，密码加密，KEY过期时间为本次签到成功即前一次密钥过期
mwMacKeyString是中间件MAC密钥使用[mwTmk](https://book.e-buy.com/books/e-buy-B6z/page/2b449 "mwTmk")进行3DES加密，HEX格式，用于中间件报文签名，KEY过期时间为本次签到成功即前一次密钥过期
webPospUrlString否为终端下发请求WEB POSP的地址用于要为终端变更新的请求地址
posUrlString否[MIS-POS](https://book.e-buy.com/link/104#bkmrk-mis-pos "安装于商户门店内的POS机具，提供活动执行辅助及兑换功能")的更新地址或目录如果为空不需要更新，否则需要更新
mwUrlString否中间件的更新地址或目录如果为空不需要更新，否则需要更新
signBankString否中间件通知[MIS-POS](https://book.e-buy.com/link/104#bkmrk-mis-pos "安装于商户门店内的POS机具，提供活动执行辅助及兑换功能")作收单行签到如果为空不需要签到，否则需要根据返回的值进行对应收单行的签到，可选值参考[收单机构标识](https://book.e-buy.com/books/e-buy-B6z/page/821fa)
headPictureListList<[headPicture](https://book.e-buy.com/books/e-buy-B6z/page/ec8ce "headPicture")>是广告图片用于显示在终端顶部
functionListList<[function](https://book.e-buy.com/books/e-buy-B6z/page/c058f "function")>是终端功能菜单下发
nextHearbeatNumber是下次心跳间隔秒数下次心跳间隔秒数
orgLogInInfosList<[orgLogInInfo](https://book.e-buy.com/books/e-buy-B6z/page/06905-nzm)>否终端对应机构信息列表
#### **返回报文举例** ``` { "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` **请求参数，中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString是请求流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transTimestampList<[transTimestamp](https://book.e-buy.com/books/e-buy-B6z/page/42998 "transTimestamp")>是交易时间戳用于统计每笔交易的耗时
businessTypeint否心跳类型0：外卖类； 1：其他类（供可扩展使用）
#### **请求报文举例** ``` { "traceNo": "HB99000009100010101732123", "transTimestamp": [ { "traceNo":"99000009100010101732123", "send":"1483372334", "recv":"1483372335" }, { "traceNo":"99000009100010101732125", "send":"1483372336", "recv":"1483372337" } ], "businessType":0 } ``` **返回参数，易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString是请求流水号原样返回
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
nextHeartbeatNumber是下次心跳间隔秒数
invokeActionString否调用的接口action如:signin 会在当日重新签到
alertMessageString否提示信息中间件弹出窗体提示这里返回的信息
businessOrderCountint否未处理订单总数用于外卖平台，获取最新未处理订单的总数
#### **返回报文举例** ``` { "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` **请求参数，中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString否线上对接使用的统一终端号对接前需提前和易百技术沟通
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123" } ``` **返回参数，易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
settleRecordList<[settleRecord](https://book.e-buy.com/books/e-buy-B6z/page/02522 "settleRecord")>是结算记录
beginDateString是结算开始时间格式：yyyyMMddHHmmss
endDateString是结算结束时间格式：yyyyMMddHHmmss
volumeInteger是总交易笔数
totalReceiptAmountPrice是商户实收总金额
totalAmountPrice是总金额所有交易汇总的金额
#### **返回报文举例** ``` { "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` **请求参数，收银机===>易百后台**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transCountInteger是本次上送笔数必须与transRecord的List大小一致
beginTimeString是交易开始时间格式：yyyyMMddHHmmss
endTimeString是交易结束时间格式：yyyyMMddHHmmss
transRecordList<[transRecord](https://book.e-buy.com/books/e-buy-B6z/page/f5f85 "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 } ] } ``` **返回参数，易百后台===>收银机**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
transRecordList<[transRecord](https://book.e-buy.com/books/e-buy-B6z/page/f5f85 "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` **请求参数，中间件===>易百后台**
字段类型是否必填字段意义备注
traceNoString是请求流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123" } ``` **返回参数，易百后台===>中间件**
字段类型是否必填字段意义备注
traceNoString是请求流水号原样返回
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
aidString是aidHEX格式
publicKeyString是ca public keyHEX格式
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "transDate": "20161231102201", "returnCode": "00", "returnDesc": "SUCCESS", "aid": "0BC8C201108F19E53D1904F12AD50DF2", "publicKey": "C716E3C7D5F8610EADDFCD5BA737CBB9" } ``` # 交易明细查询 #### **接口用途** - 查询自最近一次结算成功时间至当前时间的交易信息 #### **接口地址** - `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/getTransList` #### **action** - `getTransList` **请求参数，收银机===>易百后台**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复,必须以yyyyMMdd(当天)作为流水号开头+递增序列
onlineTidString否线上对接使用的统一终端号对接前需提前和易百技术沟通
pageSizeInteger是页大小每一页的交易数据条数
pageNoInteger是页数查看的第几页数据，0为最后一页
printOnlyInteger否仅打印不送：默认无特殊处理，0：去除printDetail，1：保留printDetail去除list类字段
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "pageSize": 2, "pageNo": 19 } ``` **返回参数，易百后台===>收银机**
字段类型是否必填字段意义备注
traceNoString是收银机流水号必须以yyyyMMdd(当天)作为流水号开头+递增序列
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
pageNoInteger是页数当前数据所在页数
countInteger是总记录数总记录数
pagesInteger是总页数总页数
beginDateString是最近一次结算成功时间格式:yyyy-MM-dd HH:mm:ss
endDateString是查询记录段结束时间一般就为当前查询操作时间 格式:yyyy-MM-dd HH:mm:ss
transInfoList<[transInfo](https://book.e-buy.com/books/e-buy-B6z/page/f5f85 "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|*如需退货需凭此小票及小票上二维码,请保留小票" } ] } ```