# 通知类接口 # 通知报文 ### 制码通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeCodeNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:MakeCodeNotify-20200702154501-U3sdD930
saleChannelIdLong取码方编号
saleChannelOrderIdString(64)取码方订单号
tradeNoString(32)易百交易编号
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
codeNumint总制码数量
userInfoObject<[userInfo](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAuserinfo%EF%BC%8C%E5%BF%85%E5%A1%AB "userInfo")>用户信息
orderRemarkJSONString制码请求上送内容原样下发
itemsList<[makeCodeNotifyItem](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakecodenot-0 "makeCodeNotifyItem")>
### 制码通知子订单明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeCodeNotifyItem`,必填
字段类型是否必填字段意义备注
saleChannelItemIdString(64)取码方子订单号
ticketIdString(20)易百券id
ticketNameString(100)券名称
thirdSendTicketIdString(20)第三制码方分配的产品代码
brandTicketIdString(20)品牌方分配的产品代码
activityIdString(20)活动id
activityNameString(100)活动名称
itemResultCodeString(2)子订单返回码
itemResultMsgString(100)子订单返回信息
validStartString码有效开始时间yyyyMMddHHmmss
validEndString码有效结束时间yyyyMMddHHmmss
codeDetailList<[makeOrderCodeDetail](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakeorderco "makeOrderCodeDetail")>码详情
makeFundsChannelObject<[makeFundsChannel](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakefundsch "makeFundsChannel")>资金渠道是否有值取决于取码方是否上传
### 制码订单码明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeOrderCodeDetail`,必填
字段类型是否必填字段意义备注
codeURLString(100)码链接
codeString(100)串码号
searchCodeString(100)查询码
useTimesInteger码可核销次数
statusString(2)状态
statusDescString(10)状态描述
passwordString(20)显示codeURL认证密码此值在某些活动需要,易百会提前告知取码方
### 制码作废通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeVoidNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:MakeVoidNotify-20200702154501-U3sdD930
saleChannelIdString(20)取码方id
saleChannelOrderIdString(64)取码方订单号
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
orderRemarkJSONString制码请求上送内容原样下发
codeListList<[makeVoidCodeDetail](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAmakevoidcod "makeVoidCodeDetail")>码明细
制码作废码明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeVoidCodeDetail`,必填
字段类型是否必填字段意义备注
codeString(100)串码号
ticketIdString(20)易百券id
### 更新码状态通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`updateCodeStatusNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:UpdateCodeStatusNotify-20200702154501-U3sdD930
codeString(100)串码号
ticketIdLong券产品id
optTagString(2)操作标识01:作废,02:冻结,03:解冻,04:激活
updateDateString更新日期yyyyMMdd
updateTimeString更新时间yyyyMMddHHmmss
saleChannelIdLong取码方编号
saleChannelOrderIdString取码方订单号
saleChannelItemIdString取码方自订单号该码对应的制码订单中子订单号
orderRemarkJSONString制码请求上送内容原样下发
verifyRemarkString核销备注信息核销接口上送原样返回
### 码延期通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`codeDelayNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:CodeDelayNotify-20200702154501-U3sdD930
codeString(100)串码号
ticketIdLong 券产品id
saleChannelIdString(20)取码方id
saleChannelOrderIdString(64)取码方制码订单号
newValidStartString(14)更新后串码有效期开始时间yyyyMMddHHmmss
newValidEndString(14)更新后串码有效期结束时间yyyyMMddHHmmss
updateDateString更新日期yyyyMMdd
updateTimeString更新时间yyyyMMddHHmmss
orderRemarkJSONString制码请求上送内容原样下发
verifyRemarkString核销备注信息核销接口上送原样返回
### 核销通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`verifyNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:VerifyNotify-20200702154501-U3sdD930
requestIdString(64)核销流水号
codeString(100)串码号
codeNumInteger本次核销该串码号出现次数
saleChannelIdLong取码方编号
saleChannelOrderIdString(64)取码方制码订单号
saleChannelItemIdString(64)取码方制码子订单订单号
verifyNumInteger本次核销请求串码兑换次数
useTimesInteger总可使用次数
remainTimesInteger剩余可使用次数
verifyRefnoString(64)系统参考号走易百posp支付网关时产生
verifyTimeString核销时间yyyyMMddHHmmss
verifyTypeInteger核销类型1:POS机验证;2:接口验证
shopNoString(20)门店店号
shopNameString(100)门店名称
cityIdString(20)城市ID
cityNameString(100)城市名称
manageCompanyString(100)门店管理公司名称
ticketIdString(20)易百券id
ticketNameString(100)券名称
ticketRemarkString(2000)券备注信息若配置的产品中存在备注信息则原样下发
thirdSendTicketIdString(20)第三制码方分配的产品代码
brandTicketIdString(20)品牌方分配的产品代码
cashierTransNoString(64)收银机交易编号
userInfoObject<[userInfo](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAuserinfo%EF%BC%8C%E5%BF%85%E5%A1%AB "userInfo")>用户信息
fineGrainedRuleLimitObject<[fineGrainedRuleLimit](https://book.e-buy.com/books/e-buy-40/page/854d9 "fineGrainedRuleLimit")>最细粒度限量规则
orderRemarkJSONString制码请求上送内容原样下发
verifyFundsChannel[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")资金信息包含Ab账户
### 核销撤销通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`verifyVoidNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:VerifyVoidNotify-20200702154501-U3sdD930
requestIdString(64)核销撤销流水号
originalRequestIdString(64)原核销流水号
codeString(100)串码号
codeCountInteger本次核销撤销该码出现次数
saleChannelIdLong取码方编号
saleChannelOrderIdString(64)取码方制码订单号
saleChannelItemIdString(63)取码方制码子订单订单号
verifyDateString(8)原核销交易时间yyyyMMdd
verifyTimeString(14)原核销交易时间yyyyMMddHHmmss
verifyVoidDateString(8)核销撤销日期yyyyMMdd
verifyVoidTimeString(14)核销撤销时间yyyyMMddHHmmss
verifyShopNoString(20)原核销门店号
verifyShopNameString(100)原核销门店名称
ticketIdString(20)易百券id
ticketNameString(100)券名称
ticketRemarkString(2000)券备注信息若配置的产品中存在备注信息则原样下发
thirdSendTicketIdString(20)第三制码方分配的产品代码
brandTicketIdString(20)品牌方分配的产品代码
originalCashierTransNoString(64)原交易收银机交易编号
userInfoObject<[userInfo](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAuserinfo%EF%BC%8C%E5%BF%85%E5%A1%AB "userInfo")>用户信息
orderRemarkJSONString制码请求上送内容原样下发
verifyFundsChannel[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")资金信息包含Ab账户
### 码过期通知数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`codeExpireNotify`,必填
字段类型是否必填字段意义备注
notifyRequestIdString(50)本次通知流水号格式:CodeExpireNotify-20200702154501-U3sdD930
orderRemarkJSONString制码请求上送内容原样下发
codeExpireDetailListList<[CodeExpireDetail](https://book.e-buy.com/link/325#bkmrk-json%C2%A0key%E4%B8%BAcodeexpired "codeExpireDetail")>码过期明细
### 码过期明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`codeExpireDetail`,必填
字段类型是否必填字段意义备注
codeString(100)串码号
ticketIdLong券产品id
validStartString(14)码有效期开始时间yyyyMMddHHmmss
validEndString(14)码有效期结束时间yyyyMMddHHmmss
### 用户信息 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`userInfo`,必填 - 该对象中字段目前不完全后期可能添加新字段
字段类型是否必填字段意义备注
mobilePhoneString(11)手机号
weChatCardPackageObject<[weChatCardPackage](https://book.e-buy.com/link/325#bkmrk-%E7%94%A8%E6%88%B7%E5%BE%AE%E4%BF%A1%E5%8D%A1%E5%8C%85%E4%BF%A1%E6%81%AF "weChatCardPackage")>微信卡包信息
### 用户微信卡包信息 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`weChatCardPackage`,必填
字段类型是否必填字段意义备注
userUnionIdString(50)微信用户唯一识别号
appIdString(20)公众号id
userOpenIdString(50)appId对应公众号下用户唯一识别号
### 下单制码资金渠道 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式") Key为`makeFundsChannel`,非必填
字段类型是否必填字段意义备注
totalAmountNumber总金额单位:分
channelBenefitNumber渠道出资优惠单位:分
merchantBenefitNumber商户出资优惠单位:分
userRealAmountNumber用户实付金额单位:分
merchantRealAmountNumber商户实收金额单位:分
# 制码订单通知 #### **接口用途** - 易百制码成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:制码通知**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识MakeCodeNotify
bizContentJSONString<[makeCodeNotify](https://book.e-buy.com/link/325#bkmrk-%E5%88%B6%E7%A0%81%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "makeCodeNotify")>制码通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 制码订单作废通知 #### **接口用途** - 易百制码订单作废成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:制码订单作废**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识MakeVoidNotify
bizContentJSONString<[makeVoidNotify](https://book.e-buy.com/link/325#bkmrk-%E5%88%B6%E7%A0%81%E4%BD%9C%E5%BA%9F%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "makeVoidNotify")>制码订单作废通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 更新码状态通知 #### **接口用途** - 取码方对码状态进行更新成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:码状态更新通知**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识UpdateCodeStatusNotify
bizContentJSONString<[updateCodeStatusNotify](https://book.e-buy.com/link/325#bkmrk-%E6%9B%B4%E6%96%B0%E7%A0%81%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "updateCodeStatusNotify")>更新码状态通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 码延期通知 #### **接口用途** - 取码方对码进行延期成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:码延期通知**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识CodeDelayNotify
bizContentJSONString<[codeDelayNotify](https://book.e-buy.com/link/325#bkmrk-%E7%A0%81%E5%BB%B6%E6%9C%9F%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "codeDelayNotify")>码延期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 码过期通知 #### **接口用途** - 当易百自制码过期后,通知到外部。 - 每天凌晨将前一天过期的码执行通知。 - 单次通知最大支持**100**个串码。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:码过期通知**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识CodeExpireNotify
bizContentJSONString<[CodeExpireNotify](https://book.e-buy.com/link/325#bkmrk-%E7%A0%81%E8%BF%87%E6%9C%9F%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "codeExpireNotify")>码延期通知[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串,Base64加密后
versionString(10)版本号
timestampString时间戳
signString签名
# 核销通知 #### **接口用途** - 串码核销成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:串码核销**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识VerifyNotify
bizContentJSONString<[verifyNotify](https://book.e-buy.com/link/325#bkmrk-%E6%A0%B8%E9%94%80%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "verifyNotify")>核销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名
# 核销撤销通知 #### **接口用途** - 串码核销撤销成功后,通知到外部。 #### **接口说明** - 该接口为异步通知接口,对接方需要提供[http](https://book.e-buy.com/books/e-buy-40/page/7f100#http "基于HTTP协议的通讯方式")接口供易百post调用。 - 签名:该报文中签名是易百私钥签名,对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。 - bizContent中的值为Base64加密后数据,此处为了查看方便,直接引用[Json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")对象。 **请求参数,[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100#whale "易百电子凭证4.0系统的别称")===>CHANNEL** **易百标准报文:串码核销撤销**
字段类型是否必填字段意义备注
appIdString(10)电子凭证系统对接方id
actionString(20)业务标识VerifyVoidNotify
bizContentJSONString<[verifyVoidNotify](https://book.e-buy.com/link/325#bkmrk-%E6%A0%B8%E9%94%80%E6%92%A4%E9%94%80%E9%80%9A%E7%9F%A5%E6%95%B0%E6%8D%AE "verifyVoidNotify")>核销撤销通知报文[json](https://book.e-buy.com/books/e-buy-40/page/7f100#json "网络通信时的一种数据交互格式")字符串
versionString(10)版本号
timestampString时间戳
signString签名