e-Buy 收银一体化

文档介绍

文档目的此为收银机或中间件与易百后台直接通讯的报文协议。为实现收银POS与易百后端支付，兑换业务交易实时同步，减少对账误差，同时可以实现与易百对接后，支持多种支付，兑换方式的需求。物理...

文档版本 (当前版本V3.3)

版本号更新日期说明更新人 V1.0 2018/2/1 初始导入陈利军 V1.1 2018/2/3 新增管理类接口：每日签到，每日结算，下载公钥个AID，下载秘钥陈...

名词解释

Socket 基于TCP/IP协议的通讯方式 MIS-POS 安装于商户门店内的POS机具，提供活动执行辅助及兑换功能易百POSP 处理e-Buy POS所有交易的一组网络设备和服务...

接口说明

调用方法

内容说明通讯方式采用 HTTPS 方式访问提交方法 POST (application/json) 交互数据格式 JSON 字符编码 UTF-8 签名算法 MD5 ...

报文结构

请求报文和返回报文都采用如下的报文结构序号参数类型参考数据参数说明备注 1 action String inquiry 交易类型具体接口有详细说明 2 ...

签名算法

签名过程拼接报文参数除sign参数外的所有参数按照ASCII顺序排序后，以"参数名1=参数值1&参数名2=参数值2"的方式拼接所有参数拼接签名 mwMacKey最后在尾部拼接...

数据加密算法

3DES介绍 3DES（或称为Triple DES）是三重数据加密算法（TDEA，Triple Data Encryption Algorithm）块密码的通称。它相当于是对每个数据块应用三次...

密码加密算法

ANSI X9.8 Format（带主帐号信息） PIN BLOCK 格式：等于 PIN 按位异或主帐号 PIN 格式：（个人识别码 Personal Identity Number）总...

密钥使用流程

一般调用流程: 当做 DownloadKey 时，使用 rootKey 来生成签名，返回报文中得到中间件主密钥 mwTmk 的密文，使用 rootKey 对该密文做3DES解密，得到 mwTm...

业务参数对象

礼品卡信息

JSON Key为cardInfo，出现在返回报文中，非必填字段类型是否必填字段意义备注 cardNo String 是卡号礼品卡号 cardStatus ...

卡信息

JSON Key为cardInfo，出现在请求报文中，非必填字段类型是否必填字段意义备注 cardNo String 是卡号卡支付类交易时为必填 passwo...

产品明细

JSON Key为goodsDetail，必填字段类型是否必填字段意义备注 goodsCategory String 是商品类别 goodsId Stri...

资金渠道

JSON Key为fundChannel，出现在返回报文中，非必填字段类型是否必填字段意义备注 channelNo String 是资金渠道编号 channe...

打印信息

JSON Key为printDetail，出现在返回报文中，非必填字段类型是否必填字段意义备注 cardNo64 String 否卡号前六后四返回需要打印的卡号...

会员信息

JSON Key为memberDetail，非必填字段类型是否必填字段意义备注 memberId String 是会员编号 memberCode Stri...

权益信息

JSON Key为rightsDetail，非必填字段类型是否必填字段意义备注 snCode String 是权益编号

结算记录

JSON Key为settleRecord，非必填字段类型是否必填字段意义备注 activityNo String 是活动编号 activityName ...

交易记录

JSON Key为transRecord，必填字段类型是否必填字段意义备注 traceNo String 是原交易收银机流水号必须包含yyyyMMdd(当天) ...

活动产品

JSON Key为activityProductList，只在需要二次交互时填写字段类型是否必填字段意义备注 activityProductNo String 是活...

交易时间戳

JSON Key为transTimestamp，必填字段类型是否必填字段意义备注 traceNo String 是原交易收银机流水号必须包含yyyyMMdd(当...

交易记录明细

JSON Key为transInfo，必填字段类型是否必填字段意义备注 action String 是交易action traceNo String 是 ...

功能菜单

JSON Key为function，出现在返回报文中字段类型是否必填字段意义备注 iconUrl String 是用于功能显示icon图下载URL 变长 tit...

图片信息

JSON Key为headPicture，出现在返回报文中字段类型是否必填字段意义备注 displayPicUrl String 是用于广告显示图片下载URL 变...

包裹明细

JSON Key为packageDetail，出现在返回报文中字段类型是否必填字段意义备注 packId String 是打包ID 变长 packName S...

订单信息

JSON Key为orderInfo，出现在返回报文中，必填字段类型是否必填字段意义备注 appOrderNo String 是应用订单号变长 statusC...

优惠券明细

JSON Key为voucherDetail，必填字段类型是否必填字段意义备注 voucherId String 是优惠券编号 voucherName St...

批量核销明细

JSON Key为ecouponsData，必填字段类型是否必填字段意义备注 code String 是劵码 status String 是核销结果返...

批量核销劵码

JSON Key为codeInfo，必填字段类型是否必填字段意义备注 code String 是劵码 activityProductNo String ...

扩展信息

JSON Key为extendsData，非必填字段类型是否必填字段意义备注 vUseInfo String 否劵使用须知 vDiscountDesc St...

集点明细

JSON Key为pointDetail，非必填字段类型是否必填字段意义备注 activityNo String 是集点活动编号 points Integ...

签购单信息

JSON Key为purchaseOrder，非必填字段类型是否必填字段意义备注 mid String 是商户编号 tid String 是终端编号...

机构信息

JSON Key为orgLogInInfo，出现在请求报文中，非必填字段类型是否必填字段意义备注 loginIndex String 是对应签到标志的寻位索引 ...

电子券包本信息

箱信息： JSON Key为voucherBox，出现在请求报文中，非必填字段类型是否必填字段意义备注 boxId String 是电子券箱号 vouch...

账户信息

JSON Key为accountInfo，非必填字段类型是否必填字段意义备注 memberCode String 是账号编号 accountType是5时，此字段...

会员积分

JSON Key为point，非必填字段类型是否必填字段意义备注 points String 是积分总数 deductileAmount String 是...

会员电子券

JSON Key为vouchers，非必填字段类型是否必填字段意义备注 voucherType String 是 coupon电子券，rights权益，cashCar...

卡券明细

JSON Key为codeDetail，非必填字段类型是否必填字段意义备注 code String 是卡券号请求时上送，原样返回 password Stri...

扩展信息-抖音线上核销报文

JSON Key为verifyOptions，非必填，包含如下三个字段（verifyToken，poiId， orderList）字段类型是否必填字段意义备注 veri...

交易类接口列表

银行卡收单

接口用途银行卡收单预付费卡消费接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/cardPayment...

实体卡权益积分兑换

接口用途银行积分兑换银行积分兑换+现金支付银行权益验证银行权益验证+现金支付会员卡消费接口地址 https://ebuywebposp-test.e-buychina....

二维码支付或兑换

接口用途支付宝支付微信被扫支付银行二维码支付(工行、中行、中信、浦发等) 银行二维码积分兑换(工行、中行、中信、浦发等) 银联立码付百度支付翼...

交易结果查询

接口用途在中间件未收到后台返回时，可以调用此接口查询原交易的状态。 “电子凭证批量核销ecouponsVerify”交易目前不支持查询接口地址 https://ebuywebposp...

当日撤销

接口用途需要对原交易整体撤销时，可以在原交易的同一天调用此接口。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/ap...

隔日退款

接口用途用户需要退款时，可以调用此接口，支持全额或部分退款（依赖支付机构的接口）。不支持券核销类交易的退款，建议调用“当日撤销void”来支持接口地址 https://ebuywe...

撤销或退款结果查询(接口处于设计开发中请勿对接)

接口用途在调用方未收到撤销或退款的后台返回时，可以调用此接口查询原撤销或退款交易的状态。接口地址 https://ebuywebposp-test.e-buychina.com/ebu...

卡余额或权益查询

接口用途银行卡积分余额查询银行卡余额查询银行卡权益次数查询预付费卡余额查询会员卡积分或余额查询接口地址 https://ebuywebposp-test.e-buych...

电子凭证查询

接口用途查询电子凭证的产品信息，可抵用的金额以及所属的活动，支持易百自有电子凭证和第三方电子凭证。接口地址 https://ebuywebposp-test.e-buychina.co...

电子凭证预核销

接口用途预核销电子凭证，模拟电子凭证核销交易提前获取核销结果信息；接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/a...

电子凭证批量核销

接口用途批量核销电子凭证，多张电子凭证核销交易；接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/ecoupo...

批量核销结果查询

接口用途当调用批量核销接口超时未收到服务端返回时，可以调本接口来查询批量核销结果；接口地址 https://ebuywebposp-test.e-buychina.com/ebuywe...

会员资产查询接口

接口用途通过身份信息查询会员资产接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/vipassets act...

会员集点

接口用途会员集点接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/accumulating action ...

活动产品选项

当通过卡BIN与码BIN无法确认具体支付渠道时，易百后台会返回活动产品列表，供中间件弹出窗体，让收银人员进行选择，选择项需填入activityProductNo字段后再向易百后台请求支付。返回报...

收单交易结果通知

接口用途银行卡收单结果通知接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/cashPosNotice ac...

管理类接口列表

下载密钥

接口用途中间件提供按钮，可以在设备初始安装时调用此接口，下载主密钥数据。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-pos...

每日签到

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

心跳

接口用途中间件定时与易百后台进行通讯，上报当前状态并同步后台服务器状态，通过后台返回的指令调用相应的接口。接口地址 https://ebuywebposp-test.e-buychin...

每日结算

接口用途汇总本次结算至上次结算时间段内的所有成功交易（含退款）。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/ap...

批上送

接口用途收银机可批量上传数据到易百后台，易百后台返回对账匹配的结果，最多支持一周内(含当天)的交易对账。接口地址 https://ebuywebposp-test.e-buychina...

对账文件

接口用途 TODO 接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/reconcilliation actio...

下载公钥和AID

接口用途当终端要操作芯片卡时，需要调用此接口获取aid,ca public key接口最好是在签到后调用接口地址 https://ebuywebposp-test.e-buychina...

交易明细查询

接口用途查询自最近一次结算成功时间至当前时间的交易信息接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/get...

外卖类接口列表

外卖开启接单

接口用途外卖开启接单接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutOpen action ...

外卖关闭接单

接口用途外卖关闭接单接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutClose action...

外卖订单列表

接口用途外卖订单列表接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutList action ...

外卖订单详情

接口用途外卖订单详情接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutDetail actio...

外卖拒绝接单

接口用途外卖拒绝接单接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutReject actio...

外卖确认接单

接口用途外卖确认接单接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutConfirm acti...

外卖取消接单

接口用途外卖取消接单接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutCancel actio...

骑手订单核销

接口用途外卖骑手订单核销接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutVerify act...

外卖订单结算

接口用途外卖订单结算接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutSettle actio...

订单核销冲正

接口用途外卖骑手订单核销接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/takeoutRollback a...

卡券管理类接口列表

批量激活卡券

接口用途供门店激活一批卡或券接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchActivate a...

按礼品卡号查询卡信息

接口用途供门店查询卡相关信息接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/getCardInfo act...

批量取消激活卡券

接口用途供门店取消激活一批卡或券接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchUnActivat...

预授权类接口列表

预授权冻结

接口用途预授权冻结操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthFreeze act...

预授权查询

接口用途预授权查询操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthQuery acti...

预授权解冻

接口用途预授权解冻操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthUnfreeze a...

预授权交易

接口用途预授权交易操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthSale actio...

新页面预授权交易查询

接口用途预授权交易查询操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthInquiry ...

预授权交易退款

接口用途预授权交易退款操作。接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthRefund a...

电子券包本处理类接口列表

激活前查询

接口用途激活前查询是否可以激活接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activePreQuery ...

激活

接口用途激活接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeVoucher action a...

激活结果查询

接口用途激活结果查询接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/activeResultQuery a...

作废

接口用途作废，作废后的券不可激活接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/delVoucher ac...

核销信息以及城市范围查询

接口用途核销信息以及城市范围查询接口地址 https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/queryVerifyInf...

POS机相关配置与说明

POS机指令说明

00 服务端下发打印文本譬如 00|支付渠道:支付宝当面付| 01 仅显示的信息 02 输入文本数据，最大30个字节的数据 |02|01|请输入原交易日期 |02|02|请输入原...

收单机构标识

下发POS的标识值易百终端标识值收单机构 AppName 二进制位置 0x01 1 招行积分（星巴克） cmbPoint 0000 0001 0x02 2 中信收单（...

Json菜单配置格式

菜单内容 [{ "iconUrl": "1级菜单icon url", "title": "1级菜单名称", "action": "", "command...

出库获取终端映射配置

接口用途机器出库时，通过机器号获取终端映射（brand，shopNo，deviceNo）请在出库前确保已配置好商户，终端，终端映射以及终端中的序列号。接口地址 https://eb...

收单cardPayment交易特殊逻辑

正交易：仅当action=cardPayment时，中间件不唤醒刷卡界面，直接组装报文请求易百后台，等待二次交互或收单指令返回。刷卡输密由子应用发起。反交易（当action=void...