# ebuy-epointvoucher # 操作说明 电子券核销相关文档 # APP操作指南： ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn01.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn02.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn03.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn04.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn05.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn06.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn07.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn08.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn09.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn10.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn11.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn12.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/appcn13.png) # 后台管理操作指南： ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn01.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn02.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn03.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn04.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn05.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn06.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn07.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn08.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn09.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn10.png) ![](https://gitbook.e-fuli.com/ebuy-epointvoucher/assets/%E5%B9%BB%E7%81%AF%E7%89%87cn11.png) # FAQ： ##### 重要！客服记录或提交问题时，务必确认3个方面： ##### 1.个人中心页面用户UID， ##### 2.问题发生的具体日期时间， ##### 3.问题描述（操作流程）。 #### **1. 登录异常问题：** Q: 无法登录，显示'帐号不存在'，'密码错误'。 A: 请分别检查用户名是否正确，密码是否正确。 Q: 无法登录，'请等待'的加载画面消失后无其他内容显示。 A: 请检查网络连接情况，是否已联网。若用户联网正常，请客服联系易百技术部。 Q: 忘记密码。 A: 邮件至易百客服部（），提供UID或帐号，进行重置密码。 #### **2. 核销及撤销问题：** Q: 常见返回码和对应的描述。 A: 返回信息及店员话术如下： \[01\]电子凭证已使用，码已核销 使用済みのためコードが無効化されています 店员可告知用户这张电子券已被核销，让用户确认是否出示了已使用过的电子券。 \[06\]过期 期限切れです 店员可告知用户这张电子券已过期。 \[09\]电子凭证不存在 電子クーポンが存在しません 店员可告知用户后台系统中没有找到这张电子券，不可使用。 \[27\]劵和品牌不一致 クーポンとブランドが一致しません 店员可告知用户这张电子券不是本品牌的券。 \[EB\_UNSUPPORTED\_COUPON\]不支持的串码 e-Buyのクーポンではありません 不是易百受理的券，店员确认是否使用错核销终端。 \[EB\_SYSTEM\_ERROR\]系统异常 システムが故障しています 店员可告知用户后台系统异常，可稍后重试。 Q: 点击核销按钮，未进入摄像头模式。 A: 在ipad设置里找到本应用，打开'相机'权限。 Q: 扫码不成功，不识别二维码。 A: 先确认扫描的是否是二维码，然后确认二维码是否清晰，是否放平，是否在扫码框范围内。 Q: 扫码成功，返回失败图标页面。 A: 表示核销失败，具体原因可参考页面下方的返回信息。若仍无法理解，请客服联系易百技术部。 Q: 扫码成功后显示白屏，或者显示'核销失败'且没有提示信息。 A: 请检查网络连接情况，是否已联网。若用户联网正常，可在交易记录中查看核销结果（以时间和券号来比对）。 若交易记录中无此交易，则可认为核销失败，可尝试重新扫码。 Q: 扫码成功后，提示核销失败"不支持的串码"。 A: 表示该二维码不是易百核销范围内的券，请确认二维码内容是否为100开头，若有疑虑请客服联系易百技术部。 Q: 找不到在哪里撤销（前提是该商户允许撤销操作）。 A: 在交易记录中找到原交易，打开详情后，最下方的'核销撤销'按钮。若没有此按钮，表示该笔交易已被撤销或该笔交易未成功。 Q: 店员APP的核销状态和用户手机端的核销状态不一致的情况。 A1: 店员APP显示核销失败或未响应，用户手机端显示已核销: ``` 首先店员在APP的交易记录列表里查看是否有该笔交易的核销结果（以时间和券号来比对）， 若有记录且成功，则认为该交易成功， 若有记录但失败或是没有记录，请客服查看后台ERP（用券号查询），以ERP的状态为准。 ``` A2: 店员APP显示核销成功，用户手机端无状态变化: ``` 认为该交易成功。 ``` #### **3. 交易记录问题：** Q: 找不到刚刚做的核销记录。 A: 先确认核销时是否有返回交易结果，若确实是异常返回，则表示核销时发生网络中断等原因，导致后台并未收到此交易，所以交易列表中无法找到。 若核销时成功返回，则检测筛选条件是否从今日开始，若是筛选的多天，则有5分钟缓存。 Q: 核销失败记录的券名称显示异常。 A: 属于正常现象，后台未识别出该券号的归属或网络中断等原因造成的核销失败，券名称会显示为'核销失败'。 Q: 页面没有任何数据显示。 A: 先确页面正中间是否有'暂无数据'的图案，若有则表示该筛选条件下无交易。若没有图案，则确认网络连接是否正常，若用户联网正常，请客服联系易百技术部。 #### **4. 其他常见问题：** Q: 下载完成打开APP，授权后页面无内容显示。 A: 部分ios版本第一次打开应用时会出现此问题，请退出并终止应用进程，然后重新打开APP即可。 Q: 什么样的券码可以用本APP核销。 A: 目前易百电子券的码bin为100，码长度为19，20，28位。 Q: 如何新增店员帐号。 A: 请商户负责人联系易百商务部（），提供开户文件。 # ebuyweb-qrpay API接口文档 # 文档版本记录
**版本号****更新日期****说明****更新人**
V1.02019/10/23初始化导入谈峥
V1.12019/10/23新增电子券类交易接口谈峥
V1.22019/10/24新增主扫类谈峥
V1.32019/10/25新增openAPI谈峥
V1.42019/10/29新增按券号查询历史交易谈峥
# 接口说明 #### 调用方法
内容说明
通讯方式采用 HTTPS 方式访问
提交方法POST (application/json)
交互数据格式JSON
字符编码UTF-8
#### 报文结构 **请求报文和返回报文都采用如下的报文结构**
参数类型参考数据参数说明备注
tokenIdStringJIOQWDIQN23123NOININVtoken值用于校验身份
langStringen/jp/cn语言类型用于区分语言
bodyStringBASE64报文内容具体接口有详细说明，本域需要采用BASE64编码
timestampString1483372334Unix时间戳单位：秒，中间件需要在收到返回时同步该时间
**报文举例** ``` { "timestamp": 1551346625000, "tokenId": "e29877a73d2141598e0e54ed24fc2e5b", "body": "", "lang": "ja" } ``` # 管理类接口 # 新页面 # 登录 #### **接口用途** - 用户名密码验证，下发token #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/loginCheck](https://qrpaymobiletest.e-buychina.com.cn/web/api/loginCheck) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
loginNameString是用户名
loginPswString是密码需加密上传：MD5(loginName + MD5(psw))
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123010", "loginName": "111", "loginPsw":"C529D04DD76D856FE3A8A871B476DC4D" } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
tokenIdString是token
merchantAddrString是商户地址
merchantNameString是商户名称
brandNameString是品牌名称
brandLogoString是品牌logo
operator[Operator](https://book.e-buy.com/books/ebuy-epointvoucher/page/8d5e9)是用户信息
#### **返回报文举例** ``` { "returnCode": "00", "tokenId": "5f2f330464bd4d2ab9cd57604fbffb99", "merchantAddr": "東京都中央区銀座8-8-11", "merchantName": "博品館TOY PARK", "returnDesc": "登录成功", "brandName": "博品館", "operator": { "operatorId": 38, "alias": "22222", "nickName": "hakuhinkan001403", "status": 1, "role": 3, "func": "0001120", "merchantId": 323427, "tid": "94392307", "currency": "JPY", "loginName": "hakuhinkan001403" }, "brandLogo": "https://jperp3.e-buychina.com/upload/20190819153240_merchant_c1562959.png" } ``` # 刷新Token #### **接口用途** - 更新token #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/refreshToken](https://qrpaymobiletest.e-buychina.com.cn/web/api/refreshToken) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123010" } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
tokenIdString是token
#### **返回报文举例** ``` { "returnCode": "00", "tokenId": "1118207c6d424de3a7bcc128aa728018", "returnDesc": "更新成功" } ``` # 个人主页信息 #### **接口用途** - 获取个人信息，显示主页 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/showOperator](https://qrpaymobiletest.e-buychina.com.cn/web/api/showOperator) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123010" } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
operator[Operator](https://book.e-buy.com/books/ebuy-epointvoucher/page/8d5e9)是用户信息
operatorChildList<[Operator](https://book.e-buy.com/books/ebuy-epointvoucher/page/8d5e9)>否店员列表主账号为店长时下发
#### **返回报文举例** ``` { "returnCode": "00", "operatorChild": [{ "role": 3, "nickName": "yangxm", "loginName": "yangxm", "remark": "杨", "operatorId": 34, "status": 1 }, { "role": 3, "nickName": "hello", "loginName": "hello", "remark": "qqq", "operatorId": 33, "status": 0 }], "returnDesc": "处理成功", "operator": { "role": 4, "merchantId": 2430, "nickName": "111", "loginName": "111", "alias": "69AE3117EC013818", "currency": "CNY", "operatorId": 27, "tid": "99001061", "status": 1 } } ``` # 新增/修改店员信息 #### **接口用途** - 店员可修改自己帐号信息，店长可修改自己帐号信息及店员的部分信息 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/addOperator](https://qrpaymobiletest.e-buychina.com.cn/web/api/addOperator) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
operator[Operator](https://book.e-buy.com/books/ebuy-epointvoucher/page/8d5e9)是用户信息新增：上送全部字段；修改：只上送id及需要修改的字段
#### **请求报文举例** ``` { "traceNo" : "MW1560133047843001211", "operator" : { "status" : 1, "remark" : "222", "loginName" : "111", "role" : 3, "loginPsw" : "C529D04DD76D856FE3A8A871B476DC4D", "nickName" : "111", "operatorId" : 27 } } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
#### **返回报文举例** ``` { "returnCode": "00", "returnDesc": "处理成功" } ``` # 交易类接口 # 电子券核销/二维码被扫 #### **接口用途** - 二维码被扫类交易统一入口 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/qrcodeSale](https://qrpaymobiletest.e-buychina.com.cn/web/api/qrcodeSale) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
totalAmountPrice是交易总金额单位：元
qrcodeString是二维码内容二维码内容
#### **请求报文举例** ``` { "traceNo": "990000091000101620150201", "totalAmount": 40.8, "qrcode": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百系统参考号
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
canPayAmountPrice是电子券面值单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
voucherDetailList<voucherDetail>否优惠券信息返回本次交易的优惠券信息
#### **返回报文举例** ``` { "extendsData":{ }, "returnCode":"00", "remainTimes":0, "invoiceAmount":1000, "receiptAmount":1000, "activityProductNo":"00000000507096", "transDate":"20190909150302", "activityProductName":"ビックカメラ1000円分クーポン券", "orderNo":"181481000584", "voucherDetail":[ { "voucherCode":"10010596750080404109" } ], "canPayAmount":1000, "paidAmount":1000, "traceNo":"794_40392571_1568008981496", "uuid":"c8c668e356b441ccbd6e253d1992eae3", "returnDesc":"SUCCESS", "step":"01", "rpcContext":"10.255.3.71:46120-->10.255.3.71:30032" } ``` # 查询交易结果 #### **接口用途** - 通过原流水号查询交易结果 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/inquiry](https://qrpaymobiletest.e-buychina.com.cn/web/api/inquiry) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
originalTraceNoString是原app流水号
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123012", "originalTraceNo": "APPTEST9100010101732123018" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百系统参考号
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
canPayAmountPrice是电子券面值单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
voucherDetailList<voucherDetail>否优惠券信息返回本次交易的优惠券信息
#### **返回报文举例** ``` { "extendsData":{ }, "returnCode":"00", "remainTimes":0, "invoiceAmount":1000, "receiptAmount":1000, "activityProductNo":"00000000507096", "transDate":"20190909150302", "activityProductName":"ビックカメラ1000円分クーポン券", "orderNo":"181481000584", "voucherDetail":[ { "voucherCode":"10010596750080404109" } ], "canPayAmount":1000, "paidAmount":1000, "traceNo":"794_40392571_1568008981496", "uuid":"c8c668e356b441ccbd6e253d1992eae3", "returnDesc":"SUCCESS", "step":"01", "rpcContext":"10.255.3.71:46120-->10.255.3.71:30032" } ``` # 撤销 #### **接口用途** - 撤销原交易（上送交易时间且不为当日时会自动调用业务主机退款接口） #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/void](https://qrpaymobiletest.e-buychina.com.cn/web/api/void) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
originalTraceNoString是原app流水号
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123012", "originalTraceNo": "APPTEST9100010101732123018" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百系统参考号
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
voucherDetailList<voucherDetail>否优惠券信息返回本次交易的优惠券信息
#### **返回报文举例** ``` { "extendsData":{ }, "returnCode":"00", "invoiceAmount":0, "receiptAmount":0, "transDate":"20190909184245", "activityProductName":"ビックカメラ1000円分クーポン券", "orderNo":"181481000589", "voucherDetail":[ { "voucherCode":"10010526553080405449" } ], "paidAmount":0, "traceNo":"209_59392775_1568022164957", "uuid":"fccd5fccae5a4efe88222439bd530d9d", "returnDesc":"操作成功", "rpcContext":"10.255.3.71:46120-->10.255.3.71:30032", "step":"01" } ``` # 筛选交易列表 #### **接口用途** - 根据条件筛选交易列表 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/getMerchantTransList](https://qrpaymobiletest.e-buychina.com.cn/web/api/getMerchantTransList) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
beginDateTimeString否筛选开始时间2019-06-20 12:00:00（不填默认当天0点）
endDateTimeString否筛选结束时间2019-06-25 23:59:59（不填默认此刻）
pagesizeint是每页条数50
pagenoint是当前页数1
noStatisticsString否无需可视化图表数据默认yes
conditionInfo[ConditionInfo](https://book.e-buy.com/books/ebuy-epointvoucher/page/d947b-Fyk)是其他筛选条件只上送筛选项
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123013", "beginDateTime": "2019-06-10 00:00:00", "endDateTime": "2019-06-18 23:59:59", "pagesize": 50, "pageno": 1, "noStatistics": "yes", "conditionInfo": { "transType": "010", //核销 撤销 退款 "returnCode": "!00" //！为不等于 } } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
totalamountPrice是统计总金额单位：元
totalcountint否统计总笔数单位：元
saleamountPrice否交易金额单位：元
refundamountPrice否退款金额单位：元
currencyString否货币类型例如:CNY
entitysList<[TransInfo](https://book.e-buy.com/books/ebuy-epointvoucher/page/019d3-QIi)>否交易列表
dateDatasListList<[DateData](https://book.e-buy.com/books/ebuy-epointvoucher/page/18d80)>否按日统计结果
appNameDatasListList<[AppNameData](https://book.e-buy.com/books/ebuy-epointvoucher/page/85d8c)>否按应用统计结果
#### **返回报文举例** ``` { "dateDatasList": [{ "amount": 0.02, "name": "20190402", "count": 3 },{ "amount": 0.02, "name": "20190403", "count": 3 }], "totalcount": 3, "returnCode": "00", "totalamount": 0.02, "saleamount": 0.02, "appNameDatasList": [{ "amount": 0.02, "name": "Alipay", "count": 2 },{ "amount": 0, "count": 1, "name": "Ecoupon" }], "currency": "CNY", "refundamount": 0, "returnDesc": "获取成功", "entitys": [ { "createTime": 1569922420000, "returnCode": "00", "transtime": "183340", "transcationId": 514, "posno": "", "transdate": "20191001", "isRefund": "0", "amount": "333.33", "appName": "Ecoupon", "isVoid": "0", "orderNo": "29_36392055_1569922420023", "nickName": "matsuya001店長", "qrcode": "10010506195921748853", "transclass": "ecoupon-verify", "traceNo": "29_36392055_1569922420023" }, { "returnCode": "00", "transtime": "145027", "amount": "0.01", "orderNo": "EP1904021450400686002000106", "nickName": "matsuya001店長", "transclass": "qrpay-sale", "isVoid": "0", "createTime": 1554187835000, "appName": "AlipayQrpay", "isRefund": "0", "transcationId": 1098, "transdate": "20190402" }, { "returnCode": "00", "transtime": "143719", "amount": "0.01", "orderNo": "EP1904021437320686002000098", "nickName": "matsuya001店長", "transclass": "qrpay-sale", "isVoid": "0", "createTime": 1554187047000, "appName": "AlipayQrpay", "isRefund": "0", "transcationId": 1097, "transdate": "20190403" } ], } ``` # 新页面按券号查询历史交易 #### **接口用途** - 根据券号筛选交易列表 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/getCodeTransList](https://qrpaymobiletest.e-buychina.com.cn/web/api/getCodeTransList) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
conditionInfo[ConditionInfo](https://book.e-buy.com/books/ebuy-epointvoucher/page/d947b-Fyk)是其他筛选条件只上送筛选项
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123013", "conditionInfo": { "qrcode": "12312312313123" } } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
totalamountPrice是统计总金额单位：元
totalcountint否统计总笔数单位：元
saleamountPrice否交易金额单位：元
refundamountPrice否退款金额单位：元
currencyString否货币类型例如:CNY
entitysList<[TransInfo](https://book.e-buy.com/books/ebuy-epointvoucher/page/019d3-QIi)>否交易列表
dateDatasListList<[DateData](https://book.e-buy.com/books/ebuy-epointvoucher/page/18d80)>否按日统计结果
appNameDatasListList<[AppNameData](https://book.e-buy.com/books/ebuy-epointvoucher/page/85d8c)>否按应用统计结果
#### **返回报文举例** ``` { "dateDatasList": [{ "amount": 0.02, "name": "20190402", "count": 3 },{ "amount": 0.02, "name": "20190403", "count": 3 }], "totalcount": 3, "returnCode": "00", "totalamount": 0.02, "saleamount": 0.02, "appNameDatasList": [{ "amount": 0.02, "name": "Alipay", "count": 2 },{ "amount": 0, "count": 1, "name": "Ecoupon" }], "currency": "CNY", "refundamount": 0, "returnDesc": "获取成功", "entitys": [ { "createTime": 1569922420000, "returnCode": "00", "transtime": "183340", "transcationId": 514, "posno": "", "transdate": "20191001", "isRefund": "0", "amount": "333.33", "appName": "Ecoupon", "isVoid": "0", "orderNo": "29_36392055_1569922420023", "nickName": "matsuya001店長", "qrcode": "10010506195921748853", "transclass": "ecoupon-verify", "traceNo": "29_36392055_1569922420023" }, { "returnCode": "00", "transtime": "145027", "amount": "0.01", "orderNo": "EP1904021450400686002000106", "nickName": "matsuya001店長", "transclass": "qrpay-sale", "isVoid": "0", "createTime": 1554187835000, "appName": "AlipayQrpay", "isRefund": "0", "transcationId": 1098, "transdate": "20190402" }, { "returnCode": "00", "transtime": "143719", "amount": "0.01", "orderNo": "EP1904021437320686002000098", "nickName": "matsuya001店長", "transclass": "qrpay-sale", "isVoid": "0", "createTime": 1554187047000, "appName": "AlipayQrpay", "isRefund": "0", "transcationId": 1097, "transdate": "20190403" } ], } ``` # 主扫类接口 # 获取主扫二维码 #### **接口用途** - 获取主扫二维码 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/web/api/merchantGetCode](https://qrpaymobiletest.e-buychina.com.cn/web/api/merchantGetCode) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是app流水号不允许重复
totalAmountPrice是金额
#### **请求报文举例** ``` { "traceNo": "APPTEST9100010101732123012", "totalAmount": 20 } ``` #### **返回参数**
字段类型是否必填字段意义备注
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
merchantQrcodeString是二维码内容
#### **返回报文举例** ``` { "returnCode": "00", "merchantQrcode": "http://qrpaytest.e-buychina.com.cn/api/user/58D49A3D48AA51D5730BAD8B2B1D16FA4AD5ABA1C0F866C7DA9E0F49778B3214B270C474D705F7C4C6FE3C47434E1EC1545B8F8EF2EE4A5AEFE42781FE69818A", "returnDesc": "操作成功" } ``` # 交易结果通知（收单机构通知易百） #### **接口用途** - 接收收单机构的异步通知 #### **接口地址** - [https://qrpaymobiletest.e-buychina.com.cn/notify/api/notifyResult/{appName}/{mid}](https://qrpaymobiletest.e-buychina.com.cn/notify/api/notifyResult/%7BappName%7D/%7Bmid%7D) #### **请求参数**
字段类型是否必填字段意义备注
appNameString是对应易百appName
midString是对应易百mid
body参数 是收单机构通知报文以机构报文为准
#### **请求报文举例** ``` ######支付宝###### { paytools_pay_amount: [{ "ALIPAYACCOUNT": "0.49" }], gmt_create: 2019 - 03 - 21 10: 14: 05, seller_email: forex_123058 @alitest.com, forex_rate: 4.91210000, subject: myMerchant000021, sign: 8 fb30d789ee7b54d8bae142e5a02b7c1, buyer_id: 2088622894549999, notify_id: 2019032100222101420049991000018313, notify_type: trade_status_sync, trans_currency: SGD, price: 0.49, trade_status: TRADE_SUCCESS, total_fee: 0.49, currency: SGD, sign_type: MD5, seller_id: 2088621894801724, buyer_email: cnbuyer_3299 @alitest.com, notify_action_type: payByAccountAction, notify_time: 2019 - 03 - 21 10: 18: 27, gmt_payment: 2019 - 03 - 21 10: 14: 18, quantity: 1, extra_common_param: { "qrcode": "https://qr.alipay.com/ocx00368onfz7rl22r7fg00", }, trans_amount: 0.10, out_trade_no: 767929382017474557294073882552983325121553134446160, trade_no: 2019032122001449991000001001 } ``` #### **返回参数**
字段类型是否必填字段意义备注
body参数String是返回信息按机构要求返回
#### **返回报文举例** ``` ######支付宝###### success ``` # 预授权类接口 # 预授权冻结 #### **接口用途** - 预授权冻结操作。 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthFreeze](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthFreeze) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
totalAmountPrice是交易总金额单位：元
qrcodeString是二维码内容串号、一维码或二维码内容
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "qrcode": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 预授权查询 #### **接口用途** - 预授权查询操作。 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthQuery](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthQuery) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
originalTraceNoString是原收银机流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 预授权解冻 #### **接口用途** - 预授权解冻操作。 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthUnfreeze](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthUnfreeze) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
refundAmountPrice是解冻总金额单位：元
originalTraceNoString是原收银机流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "refundAmount": 40.8, "originalTraceNo": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 预授权交易 #### **接口用途** - 预授权交易操作。 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthSale](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthSale) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
totalAmountPrice是交易总金额单位：元
originalTraceNoString是原冻结操作流水号扫码获得
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "totalAmount": 40.8, "originalTraceNo": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 预授权交易查询 #### **接口用途** - 预授权交易查询操作。 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthInquiry](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthInquiry) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
originalTraceNoString是原交易流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "originalTraceNo": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 预授权交易退款 #### **接口用途** - 预授权交易退款操作 #### **接口地址** - [https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthRefund](https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/preauthRefund) #### **请求参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
refundAmountPrice是退款总金额单位：元
originalTraceNoString是原收银机流水号
#### **请求报文举例** ``` { "traceNo": "99000009100010101732123", "refundAmount": 40.8, "originalTraceNo": "280123121234567890" } ``` #### **返回参数**
字段类型是否必填字段意义备注
traceNoString是收银机流水号不允许重复
orderNoString是交易订单号易百生成
transDateString是交易时间格式为：yyyyMMddHHmmss
returnCodeString是返回码00表示交易成功，其他表示失败
returnDescString是返回信息交易结果描述或错误原因
paidAmountPrice是支付成功总金额单位：元
receiptAmountPrice否商户实收金额单位：元
invoiceAmountPrice否商户开票金额单位：元
exchangeRateNumber(8,6)否汇率1外币等于多少人民币
currencyString否货币类型例如:CNY
discountCodeString否折扣编码由收银机分配，用于入账计折扣类型
discountNumNumber否固定金额折扣数量用于入账计折扣类型的数量
tenderCodeString否支付方式编码由收银机分配，用于入账计支付方式
activityProductNoString否活动产品编号
activityProductNameString否活动产品名称
goodsDetailList<goodsDetail>否折抵产品明细返回后台已抵扣成功的产品明细
fundChannelList<fundChannel>否资金渠道
printDetailObject<printDetail>否打印信息如需要在收银小票上打印信息时必填
memberDetailObject<memberDetail>否会员信息返回本次交易的会员信息
voucherDetailList<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.api-location-url.com/url", "qrCode2": "", "qrCode3": "", "barCode1": "12345679", "barCode2": "", "barCode3": "" }, "memberDetail": { "memberId": "M000001545", "memberName": "TONY", "grade": "1", "status": "1", "balance": 1000.00, "pointBalance": 30000 }, "voucherDetail": [ { "voucherId": "001", "voucherName": "现金优惠券", "voucherType": "现金", "voucherCode": "123456789", "channelAmount": "20.8" }, { "voucherId": "002", "voucherName": "买一赠一优惠券", "voucherType": "买赠", "voucherCode": "1232136781", "channelAmount": "20.8" } ] } ``` # 参数对象说明 # 用户信息
字段类型是否必填字段意义备注
operatorIdLong是用户id
aliasString否别名用于推送
nickNameString是昵称
roleint是角色3店员，4店长
merchantIdint是门店主键id
tidString是绑定使用的终端号
currencyString是该帐号币种
loginNameString是用户名
funcString是功能配置见func字段解析
**func字段解析：** 第1位：是否支持主扫 第2位：是否支持被扫 第3位：是否支持预授权 第4位：是否支持电子券 第5位：是否禁止撤销 第6位：是否添加回到首页按钮 第7位：是否强制输入收银流水号 第8位：是否token保持 # 筛选条件信息
字段类型是否必填字段意义备注
transTypeString否交易类型筛选按位多选
returnCodeString否交易结果筛选
qrcodeString否券码
**transType解析** 第1位：正交易 第2位：撤销 第3位：退款 如"010"代表只筛选撤销交易 **returnCode解析** 00表示筛选成功交易 !00表示筛选不成功的交易 ERROR\_CODE表示筛选该返回码的交易 # 交易数据信息
字段类型是否必填字段意义备注
returnCodeString否交易结果筛选
amountPrice否交易金额单位：元
traceNoString是app流水号
appNameString是易百后台业务主机
qrcodeString否券码号
nickNameString否该笔交易的操作员
transdateString是交易日期yyyyMMdd
transtimeString是交易时间hhmmss
transclassString是交易类型
is\_voidString是是否撤销
is\_refundString是是否退款
transcationIdLong是交易记录主键
createTimeLong是交易时间时间戳
posnoString否商户自定义流水号
# 按日统计结果
字段类型是否必填字段意义备注
amountPrice是交易金额
countint是交易笔数
nameString是日期
# 按应用统计结果
字段类型是否必填字段意义备注
amountPrice是交易金额
countint是交易笔数
nameString是应用名
# 主扫open-api # 版本历史及更新说明 v1.00 2018-07-16 17:00 中文第一版 v1.01 2018-07-16 18:00 修复描述错误 v1.02 2018-07-16 19:00 新增查询接口和退款接口的部分返回字段 v2.00 2019-10-10 15:00 简化对接方式 v2.01 2019-10-10 18:00 测试环境更新为https # 前言 ### 流程说明 1. 第三方发起二维码数据请求，并把相关的身份标志提交给易百开放的接口，易百安全验证且验证身份通过后会返回二维码对应的数据； 2. 第三方获取到二维码数据，用数据以二维码的样式展示，展示的载体由第三方自行定义 3. 消费者打开易百所支持的支付类钱包，扫描第三方所展示的二维码，确认金额后支付； 4. 易百得到消费者支付的结果生成对应的支付记录，供第三方查询支付结果； 5. ### 名词解释和统一报文结构 1. 字段说明中，N为必填，O为选填。 2. 响应报文外层参数callReturnCode：表示接口调用是否成功； 响应报文body内参数returnCode：表示该请求实际的交易结果是否成功； #### 请求 (加密，签名前)： ``` { "action": "merchantGetCodeImpl", //N，action值，不同接口对应不同的action "uid": "sg_1458_001", //N，商户号，由易百分配 "psw": "F52FB1124231E6BA683F5C2CB5C8ADF6", //N，终端号，由易百分配，需加密见1.4 "body": { //N，报文主体内容，需要加密，加密方法见1.4 "orderNo": "12345678920", "totalAmount": 0.01, "goodsDetail": [{ "goodsId": "434", "goodsName": "奶茶", "price": 0.01, "quantity": 1 }] }, "sign": "xxxxxxx" //N，签名值，签名方法见1.5 } ``` #### 响应（验签，解密后）： ``` { "sign": "xxxxxxx", //N，签名值，验签方法见1.5 "body": { //N，报文主题内容，解密方法见1.4 "returnCode": "00", "orderNo": "12345678920", "returnDesc": "操作成功", "orderNoQrcode": "http://qrpaytest.e-buychina.com.cn/api/user/0D8DF0B717B4190292B8A6044DDC1B9B65CE6B244F3706A70BCD9C7C5802C15D0C59789C48F7F308572C6DFFD4694C7F730A27C2290BA9B1DFFA97C8AE14A731" }, "callReturnCode": "00", //N，接口调用结果返回码 "callReturnDesc": "Interface call success", //N，接口调用结果返回结果 "action": "merchantGetCodeImpl", //N，action值，和请求一致 } ``` ### body报文主题加解密方法 body加密时，对body的JSON格式字符串进行Base64加密。 body解密时，进行Base64解密。 psw加密：MD5(uid + MD5（psw）) MD5均为32位加密，大写 ### sign签名和验签方法 1. 签名数据（除sign字段外按key字典顺序按key1=value1&key2=value2&key3=value3&......拼接），最后拼接KEY=xxxx（易百提供的macKey）； 2. 签名时，对签名数据进行MD5加密（32位）； 3. 测试环境暂时不验签。 ### 请求地址及测试参数 1. 通讯方式HTTPS，字符编码UTF-8，交互数据格式Json 1. 测试环境请求地址： [https://qrpaymobiletest.e-buychina.com.cn/api/openApi/merchant](https://qrpaymobiletest.e-buychina.com.cn/api/openApi/merchant) 1. 测试参数： uid：sg\_1458\_001 psw：654321 key：499E8A1D1E295E76688A5D9B695312E9 # API列表 # 获取二维码 ##### action名称：merchantGetCodeImpl ##### 方法说明：用于获取二维码url #### 请求参数：body内字段如下： ``` { "orderNo": "12345678920", //N，商户订单号，必须全局唯一不重复 "totalAmount": 0.01, //N，订单总金额，单位元 "goodsDetail": [{ //O，产品明细 "goodsId": "434", //N，产品id "goodsName": "奶茶", //N，产品名称 "price": 0.01, //N，产品价格，单位元 "quantity": 1 //N，产品数量 }] } ``` #### 响应参数：body内字段如下： ``` { "returnCode": "00", //N，结果返回码，00为成功，其余为失败 "orderNo": "12345678920", //N，商户订单号，和请求一致 "returnDesc": "操作成功", //N，结果返回描述 "orderNoQrcode": http://qrpaytest.e-buychina.com.cn/api/user/0D8DF0B717B4190292B8A6044DDC1B9B65CE6B244F3706A70BCD9C7C5802C15D0C59789C48F7F308572C6DFFD4694C7F730A27C2290BA9B1DFFA97C8AE14A731 //N，二维码内容 } ``` # 查询交易结果 ##### action名称：merchantInquiryImpl ##### 方法说明：用于查询交易结果，用户扫码二维码并支付之后，可轮询查询 #### 请求参数：body内字段如下： ``` { "orderNo": "12345678920", //N，原交易商户订单号 } ``` #### 响应参数：body内字段如下： ``` { "returnCode": "00", //N，原交易返回码，00为成功，其余为失败 "returnDesc": "交易成功", //N，原交易交易结果返回描述 "orderNo": "12345678920", //N，和请求一致 "totalAmount": 20.0, //O，原交易订单金额 "realAmount": 15.0, //O，原交易用户实付金额 "ebuyRefno": 17409898978, //O，原交易ebuy系统参考号 "ebuyRequestNo": 423894394, //O，原交易ebuy上送机构的订单号 "organizationTradeNo ":90909090, //O，原交易机构返回订单号 } ``` # 退款 ##### action名称：merchantRefundImpl ##### 方法说明：用于获取二维码url #### 请求参数：body内字段如下： ``` { "orderNo": "12345678920", //N，原交易商户订单号 "refundAmount ": 0.10, //O，本次退款金额，不填则默认全额退款 } ``` #### 响应参数：body内字段如下： ``` { "returnCode": "00", //N，退款返回码，00为成功，其余为失败 "returnDesc": "操作成功", //N，退款结果返回描述 "orderNo": "12345678920", //N，和请求一致 "refundAmount ": 0.10, //O，申请退款的金额，和请求一致 "totalAmount": 20.0, //O，原交易订单金额 "realAmount": 15.0, //O，退款金额 "ebuyRefno": 17409898978, //O，退款 ebuy系统参考号 "ebuyRequestNo": 423894394, //O，退款ebuy上送机构的订单号 "organizationTradeNo ":90909090, //O，退款机构返回订单号 } ```