# 交易类接口 # 银行卡收单 #### **交易流程说明** - 该交易发至中间件后,中间件不会直接请求易百后台,而是先点亮[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能"),等待刷卡和输入密码,[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能")上确认后,中间件收到卡和密码信息再请求易百后台进行处理。 #### **action** - `cardPayment` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,建议YYYYmmddHHMMSS+10位流水号
totalAmountPrice交易总金额单位:元
undiscountAmountPrice不可打折金额单位:元
acquirerString收单机构如:citicCashpay表示中信收单
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>产品明细验证产品明细时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息会员支付时必填
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "undiscountAmount": 0, "acquirer": "citicCashpay", "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000" } ], "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号易百生成
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
paidAmountPrice支付成功总金额面值,单位:元
receiptAmountPrice商户实收金额净值,单位:元
invoiceAmountPrice商户开票金额单位:元
exchangeRateNumber(8,6)汇率1外币等于多少人民币
currencyString货币类型例如:CNY
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
discountNumNumber固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
activityProductNoString活动产品编号
activityProductNameString活动产品名称
needSameCardBoolean同一张卡支付如满额立减类活动,需要同一张银行卡支付剩余金额
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
paymentExtraObject<[paymentDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/b53b3 "payMentDetail")>收单信息返回本次交易的收单信息
#### **返回报文举例** ``` { "traceNo": "9900000910001011920150201", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "paidAmount": 40.8, "receiptAmount": 40.8, "invoiceAmount": 40.8, "exchangeRate": 6.0939, "currency": "CNY", "discountCode": "0001", "discountNum": 20, "tenderCode": "8001", "activityProductNo": "00000000089349", "activityProductName": "中信365权益", "needSameCard": true, "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" } ], "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "cardInfo": { "cardNo": "", "password": "", "valid": "", "track1": "", "track2": "", "track3": "", "cardSn": "", "icData": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ], "paymentExtra": { "acqId": "0100", "issuerId": "0200", "cardType": "0001", "cardOrgan": false, "pan": "622562****8888", "aid": "A000000333010101" } } ``` # 实体卡权益积分兑换 #### **接口用途** - 银行积分兑换 - 银行积分兑换+现金支付 - 银行权益验证 - 银行权益验证+现金支付 - 预付费卡消费 - 会员卡消费 #### **交易流程说明** - 该交易发至中间件后,中间件不会直接请求易百后台,而是先点亮[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能"),等待刷卡和输入密码,[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能")上确认后,中间件收到卡和密码信息再请求易百后台进行处理。 #### **action** - `cardRedemption` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,建议YYYYmmddHHMMSS+10位流水号
totalAmountPrice交易总金额单位:元
undiscountAmountPrice不可打折金额单位:元
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>产品明细验证产品明细时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息会员支付时必填
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "undiscountAmount": 0, "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000" } ], "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号易百生成
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
paidAmountPrice支付成功总金额面值,单位:元
receiptAmountPrice商户实收金额净值,单位:元
invoiceAmountPrice商户开票金额单位:元
exchangeRateNumber(8,6)汇率1外币等于多少人民币
currencyString货币类型例如:CNY
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
discountNumNumber固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
activityProductNoString活动产品编号
activityProductNameString活动产品名称
needSameCardBoolean同一张卡支付如满额立减类活动,需要同一张银行卡支付剩余金额
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "paidAmount": 40.8, "receiptAmount": 40.8, "invoiceAmount": 40.8, "exchangeRate": 6.0939, "currency": "CNY", "discountCode": "0001", "discountNum": 20, "tenderCode": "8001", "activityProductNo": "2016123101", "activityProductName": "中信365权益", "needSameCard": true, "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" } ], "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` # 二维码支付或兑换 #### **接口用途** - 支付宝支付 - 微信被扫支付 - 银行二维码支付 - 银行二维码积分兑换 - 银联立码付 - 百度支付 - 翼支付 - 其他二维码支付 - 产品券/代金券/折扣券/买N赠M券/立减券 - 外卖或自助点单订单码自动上屏 #### **交易流程说明** - 该交易需要先采集二维码扫描器或键盘输入的二维码信息,再发至中间件,中间件收到请求后,检查包含qrcode内容信息再请求易百后台进行处理。 #### **action** - `qrcodeSale` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复,建议YYYYmmddHHMMSS+10位流水号
totalAmountPrice交易总金额单位:元
undiscountAmountPrice不可打折金额单位:元
qrcodeString二维码内容串号、一维码或二维码内容
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>产品明细验证产品明细时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息会员支付时必填
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "undiscountAmount": 0, "qrcode": "280123121234567890", "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000" } ], "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号易百生成
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
paidAmountPrice支付成功总金额单位:元
receiptAmountPrice商户实收金额单位:元
invoiceAmountPrice商户开票金额单位:元
exchangeRateNumber(8,6)汇率1外币等于多少人民币
currencyString货币类型例如:CNY
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102\\10.00表示折扣10元
discountNumNumber固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101\\20.00表示支付20元
activityProductNoString活动产品编号
activityProductNameString活动产品名称
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
voucherDetailList<[voucherDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/084b6 "voucherDetail")>优惠券信息返回本次交易的优惠券信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "paidAmount": 40.8, "receiptAmount": 40.8, "invoiceAmount": 40.8, "exchangeRate": 6.0939, "currency": "CNY", "discountCode": "0001", "discountNum": 20, "tenderCode": "8001", "activityProductNo": "2016123102", "activityProductName": "支付宝支付", "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" } ], "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中国银行", "paymentOrderNo": "201612315689412157458787", "paymentUser": "139****@163.com", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` # 交易结果查询 #### **接口用途** - 在收银机未收到后台返回时,可以调用此接口查询原交易的状态。 #### **action** - `inquiry` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
originalTraceNoString原收银机流水号传入需要查询的原交易收银机流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732124" } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号单位:元
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
paidAmountPrice支付成功总金额单位:元
receiptAmountPrice商户实收金额单位:元
invoiceAmountPrice商户开票金额单位:元
exchangeRateNumber(8,6)汇率1外币等于多少人民币
currencyString货币类型例如:CNY
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
discountNumNumber固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
activityProductNoString活动产品编号
activityProductNameString活动产品名称
needSameCardBoolean同一张卡支付如满额立减类活动,需要同一张银行卡支付剩余金额
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
voucherDetailList<[voucherDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/084b6 "voucherDetail")>优惠券信息返回本次交易的优惠券信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "paidAmount": 40.8, "receiptAmount": 40.8, "invoiceAmount": 40.8, "exchangeRate": 6.0939, "currency": "CNY", "discountCode": "0001", "discountNum": 20, "tenderCode": "8001", "activityProductNo": "2016123102", "activityProductName": "支付宝支付", "needSameCard": true, "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000", "activityNo": "2016123101", "memo": "100123456789" } ], "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中国银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **支持查询的交易** - cardSale - qrcodeSale # 当日撤销(实体卡) #### **接口用途** - 需要对原交易整体撤销时,可以在原交易的同一天调用此接口。 #### **交易流程说明** - 该交易发至中间件后,中间件不会直接请求易百后台,而是先点亮[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能"),等待刷卡和输入密码,[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能")上确认后,中间件收到卡和密码信息再请求易百后台进行处理。 #### **action** - `voidCardSale` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
originalTraceNoString原收银机流水号传入需要查询的原交易收银机流水号
acquirerString收单机构如:citicCashpay表示中信收单,如果收单撤销是必填的
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732124", "acquirer": "citicCashpay" } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "discountCode": "0001", "tenderCode": "8001", "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **支持撤销的交易** - cardPayment - cardRedemption # 当日撤销(二维码) #### **接口用途** - 需要对原交易整体撤销时,可以在原交易的同一天调用此接口。 #### **action** - `voidQrcodeSale` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
originalTraceNoString原收银机流水号传入需要查询的原交易收银机流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732124" } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "discountCode": "0001", "tenderCode": "8001", "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **支持撤销的交易** - qrcodeSale # 隔日退款(实体卡) #### **接口用途** - 用户需要退款时,可以调用此接口,支持全额或部分退款(依赖支付机构的接口)。 #### **交易流程说明** - 该交易发至中间件后,中间件不会直接请求易百后台,而是先点亮[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能"),等待刷卡和输入密码,[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能")上确认后,中间件收到卡和密码信息再请求易百后台进行处理。 #### **action** - `refundCardSale` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
originalTraceNoString原收银机流水号传入需要退款的原交易收银机流水号
refundAmountPrice本次退款金额单位:元
acquirerString收单机构如:citicCashpay表示中信收单,如果收单撤销是必填的
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732124", "refundAmount": 40.8, "acquirer": "citicCashpay" } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
refundAmountPrice退款成功总金额单位:元
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "discountCode": "0001", "tenderCode": "8001", "refundAmount": 40.8, "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **支持退款的交易** - cardPayment - CardRedemption # 隔日退款(二维码) #### **接口用途** - 用户需要退款时,可以调用此接口,支持全额或部分退款(依赖支付机构的接口)。 #### **action** - `refundQrcodeSale` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
originalTraceNoString原收银机流水号传入需要退款的原交易收银机流水号
refundAmountPrice本次退款金额单位:元
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "99000009100010101732124", "refundAmount": 40.8 } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
refundAmountPrice退款成功总金额单位:元
discountCodeString折扣编码由收银机分配,用于入账计折扣类型,如:2016120102|10.00表示折扣10元
tenderCodeString支付方式编码由收银机分配,用于入账计支付方式,如:2016120101|20.00表示支付20元
fundChannelList<[fundChannel](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/e00da "fundChannel")>资金渠道
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "refundAmount": 40.8, "discountCode": "0001", "tenderCode": "8001", "fundChannel": [ { "channelNo": "001", "channelName": "用户实付现金", "channelAmount": "20.8" }, { "channelNo": "002", "channelName": "用户积分支付", "channelAmount": "20" } ], "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **支持退款的交易** - qrcodeSale # 卡余额或权益查询 #### **接口用途** - 银行卡积分余额查询 - 银行卡余额查询 - 银行卡权益次数查询 - 预付费卡余额查询 - 会员卡积分或余额查询 #### **交易流程说明** - 该交易发至中间件后,中间件不会直接请求易百后台,而是先点亮[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能"),等待刷卡和输入密码,[MIS-POS](https://book.e-buy.com/link/391#bkmrk-mis-pos "安装于商户门店内的POS机具,提供活动执行辅助及兑换功能")上确认后,中间件收到卡和密码信息再请求易百后台进行处理。 #### **action** - `balance` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
activityProductNoString活动产品编号卡BIN不明确时必填,易百分配
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息会员交易时必填
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "activityProductNo": "HDCP00000000001236", "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号单位:元
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
rightsTimesInteger权益次数返回可以享受的权益次数
moneyBalancePrice现金余额单位:元
pointBalancePrice积分余额单位:分
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "rightsTimes": 1, "moneyBalance": 40.8, "pointBalance": 40000, "printDetail": { "cardNo64": "622562****8888", "bank": "中信银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "0", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` # 电子凭证查询 #### **接口用途** - 查询电子凭证的产品信息,可抵用的金额以及所属的活动,支持易百自有电子凭证和第三方电子凭证。 #### **交易流程说明** - 该交易需要先采集二维码扫描器或键盘输入的二维码信息,再发至中间件,中间件收到请求后,检查包含ecoupon内容信息再请求易百后台进行处理。 #### **action** - `ecouponInquiry` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
qrcodeString电子凭证号要查询的电子凭证号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "qrcode": "00000001235" } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号单位:元
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
canPayAmountPrice可抵用的总金额单位:元
activityProductNoString活动产品编号该电子凭证所属的活动产品编号
activityProductNameString活动产品名称该电子凭证所属的活动产品名称
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "canPayAmount": 40.8, "activityProductNo": "2016123101", "activityProductName": "中信365权益" } ``` # 会员集点 #### **接口用途** - 会员集点 #### **action** - `accumulating` #### **请求参数,收银机===>中间件**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
totalAmountPrice交易总金额单位:元
undiscountAmountPrice不可打折金额单位:元
activityNoString集点活动编号收银机集点时填写,后台集点不填
pointsInteger集点点数收银机集点时填写,后台集点不填
goodsDetailList<[goodsDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/a0a08 "goodsDetail")>产品明细验证产品明细时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息会员支付时必填
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "undiscountAmount": 0, "activityNo": "2016121901", "points": 100, "goodsDetail": [ { "goodsCategory": "001", "goodsId": "P00001", "goodsName": "牙膏", "price": 8, "quantity": 2, "rebateCode": "000" }, { "goodsCategory": "101", "goodsId": "P00002", "goodsName": "洗发水", "price": 24.8, "quantity": 1, "rebateCode": "000" } ], "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ``` #### **返回参数,中间件===>收银机**
字段类型是否必填字段意义备注
traceNoString收银机流水号不允许重复
orderNoString交易订单号易百生成
transDateString交易时间格式为:YYYYmmddHHMMSS
returnCodeString返回码00表示交易成功,其他表示失败
returnDescString返回信息交易结果描述或错误原因
activityProductNoString集点活动产品编号
activityProductNameString集点活动产品名称
printDetailObject<[printDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/310dc "printDetail")>打印信息如需要在收银小票上打印信息时必填
memberDetailObject<[memberDetail](https://book.e-buy.com/books/ebuy-cashier-middleware-api/page/559cb "memberDetail")>会员信息返回本次交易的会员信息
#### **返回报文举例** ``` { "traceNo": "99000009100010101732123", "orderNo": "171698602301", "transDate": "20161231120533", "returnCode": "00", "returnDesc": "SUCCESS", "activityProductNo": "2016123102", "activityProductName": "圣诞集点活动", "printDetail": { "cardNo64": "622562****8888", "bank": "中国银行", "paymentOrderNo": "201612315689412157458787", "pointSale": "20000", "qrCode1": "htt://www.xxx.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 } } ```