通知类接口

• 通知报文
• 制码订单通知
• 制码订单作废通知
• 更新码状态通知
• 码延期通知
• 码过期通知
• 核销通知
• 核销撤销通知

通知报文

制码通知数据

• JSON Key为makeCodeNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：MakeCodeNotify-20200702154501-U3sdD930
  saleChannelId	Long	是	取码方编号
  saleChannelOrderId	String(64)	是	取码方订单号
  tradeNo	String(32)	是	易百交易编号
  createDate	String	是	创建日期	yyyyMMdd
  createTime	String	是	创建时间	yyyyMMddHHmmss
  codeNum	int	是	总制码数量
  userInfo	Object<userInfo>	否	用户信息
  orderRemark	JSONString	否	制码请求上送内容原样下发
  items	List<makeCodeNotifyItem>

制码通知子订单明细

• JSON Key为makeCodeNotifyItem，必填

字段	类型	是否必填	字段意义	备注
saleChannelItemId	String(64)	是	取码方子订单号
ticketId	String(20)	否	易百券id
ticketName	String(100)	否	券名称
thirdSendTicketId	String(20)	否	第三制码方分配的产品代码
brandTicketId	String(20)	否	品牌方分配的产品代码
activityId	String(20)	否	活动id
activityName	String(100)	否	活动名称
itemResultCode	String(2)	是	子订单返回码
itemResultMsg	String(100)	是	子订单返回信息
validStart	String	是	码有效开始时间	yyyyMMddHHmmss
validEnd	String	是	码有效结束时间	yyyyMMddHHmmss
codeDetail	List<makeOrderCodeDetail>	否	码详情
makeFundsChannel	Object<makeFundsChannel>	否	资金渠道	是否有值取决于取码方是否上传

制码订单码明细

• JSON Key为makeOrderCodeDetail，必填

字段	类型	是否必填	字段意义	备注
codeURL	String(100)	否	码链接
code	String(100)	是	串码号
searchCode	String(100)	否	查询码
useTimes	Integer	是	码可核销次数
status	String(2)	是	状态
statusDesc	String(10)	是	状态描述
password	String(20)	否	显示codeURL认证密码	此值在某些活动需要，易百会提前告知取码方

制码作废通知数据

• JSON Key为makeVoidNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：MakeVoidNotify-20200702154501-U3sdD930
  saleChannelId	String(20)	是	取码方id
  saleChannelOrderId	String(64)	是	取码方订单号
  createDate	String	是	创建日期	yyyyMMdd
  createTime	String	是	创建时间	yyyyMMddHHmmss
  orderRemark	JSONString	否	制码请求上送内容原样下发
  codeList	List<makeVoidCodeDetail>	否	码明细

  制码作废码明细

• JSON Key为makeVoidCodeDetail，必填

字段	类型	是否必填	字段意义	备注
code	String(100)	是	串码号
ticketId	String(20)	是	易百券id

更新码状态通知数据

• JSON Key为updateCodeStatusNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：UpdateCodeStatusNotify-20200702154501-U3sdD930
  code	String(100)	是	串码号
  ticketId	Long	是	券产品id
  optTag	String(2)	是	操作标识	01:作废，02：冻结，03：解冻，04：激活
  updateDate	String	是	更新日期	yyyyMMdd
  updateTime	String	是	更新时间	yyyyMMddHHmmss
  saleChannelId	Long	是	取码方编号
  saleChannelOrderId	String	是	取码方订单号
  saleChannelItemId	String	是	取码方自订单号	该码对应的制码订单中子订单号
  orderRemark	JSONString	否	制码请求上送内容原样下发
  verifyRemark	String	否	核销备注信息	核销接口上送原样返回

码延期通知数据

• JSON Key为codeDelayNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：CodeDelayNotify-20200702154501-U3sdD930
  code	String(100)	是	串码号
  ticketId	Long		券产品id
  saleChannelId	String(20)	是	取码方id
  saleChannelOrderId	String(64)	是	取码方制码订单号
  newValidStart	String(14)	是	更新后串码有效期开始时间	yyyyMMddHHmmss
  newValidEnd	String(14)	是	更新后串码有效期结束时间	yyyyMMddHHmmss
  updateDate	String	是	更新日期	yyyyMMdd
  updateTime	String	是	更新时间	yyyyMMddHHmmss
  orderRemark	JSONString	否	制码请求上送内容原样下发
  verifyRemark	String	否	核销备注信息	核销接口上送原样返回

核销通知数据

• JSON Key为verifyNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：VerifyNotify-20200702154501-U3sdD930
  requestId	String(64)	是	核销流水号
  code	String(100)	是	串码号
  codeNum	Integer	是	本次核销该串码号出现次数
  saleChannelId	Long	是	取码方编号
  saleChannelOrderId	String(64)	是	取码方制码订单号
  saleChannelItemId	String(64)	是	取码方制码子订单订单号
  verifyNum	Integer	是	本次核销请求串码兑换次数
  useTimes	Integer	否	总可使用次数
  remainTimes	Integer	否	剩余可使用次数
  verifyRefno	String(64)	否	系统参考号	走易百posp支付网关时产生
  verifyTime	String	是	核销时间	yyyyMMddHHmmss
  verifyType	Integer	是	核销类型	1:POS机验证；2:接口验证
  shopNo	String(20)	否	门店店号
  shopName	String(100)	否	门店名称
  cityId	String(20)	是	城市ID
  cityName	String(100)	是	城市名称
  manageCompany	String(100)	否	门店管理公司名称
  ticketId	String(20)	是	易百券id
  ticketName	String(100)	是	券名称
  ticketRemark	String(2000)	否	券备注信息	若配置的产品中存在备注信息则原样下发
  thirdSendTicketId	String(20)	否	第三制码方分配的产品代码
  brandTicketId	String(20)	否	品牌方分配的产品代码
  cashierTransNo	String(64)	否	收银机交易编号
  userInfo	Object<userInfo>	否	用户信息
  fineGrainedRuleLimit	Object<fineGrainedRuleLimit>	否	最细粒度限量规则
  orderRemark	JSONString	否	制码请求上送内容原样下发
  verifyFundsChannel	fundsChannel	是	资金信息包含Ab账户

核销撤销通知数据

• JSON Key为verifyVoidNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：VerifyVoidNotify-20200702154501-U3sdD930
  requestId	String(64)	是	核销撤销流水号
  originalRequestId	String(64)	是	原核销流水号
  code	String(100)	是	串码号
  codeCount	Integer	是	本次核销撤销该码出现次数
  saleChannelId	Long	是	取码方编号
  saleChannelOrderId	String(64)	是	取码方制码订单号
  saleChannelItemId	String(63)	是	取码方制码子订单订单号
  verifyDate	String(8)	是	原核销交易时间	yyyyMMdd
  verifyTime	String(14)	是	原核销交易时间	yyyyMMddHHmmss
  verifyVoidDate	String(8)	是	核销撤销日期	yyyyMMdd
  verifyVoidTime	String(14)	是	核销撤销时间	yyyyMMddHHmmss
  verifyShopNo	String(20)	否	原核销门店号
  verifyShopName	String(100)	否	原核销门店名称
  ticketId	String(20)	是	易百券id
  ticketName	String(100)	是	券名称
  ticketRemark	String(2000)	否	券备注信息	若配置的产品中存在备注信息则原样下发
  thirdSendTicketId	String(20)	否	第三制码方分配的产品代码
  brandTicketId	String(20)	否	品牌方分配的产品代码
  originalCashierTransNo	String(64)	否	原交易收银机交易编号
  userInfo	Object<userInfo>	否	用户信息
  orderRemark	JSONString	否	制码请求上送内容原样下发
  verifyFundsChannel	fundsChannel	是	资金信息包含Ab账户

码过期通知数据

• JSON Key为codeExpireNotify，必填

  字段	类型	是否必填	字段意义	备注
  notifyRequestId	String(50)	是	本次通知流水号	格式：CodeExpireNotify-20200702154501-U3sdD930
  orderRemark	JSONString	否	制码请求上送内容原样下发
  codeExpireDetailList	List<CodeExpireDetail>	否	码过期明细

码过期明细

• JSON Key为codeExpireDetail，必填

字段	类型	是否必填	字段意义	备注
code	String(100)	是	串码号
ticketId	Long	是	券产品id
validStart	String(14)	是	码有效期开始时间	yyyyMMddHHmmss
validEnd	String(14)	是	码有效期结束时间	yyyyMMddHHmmss

用户信息

• JSON Key为userInfo，必填
• 该对象中字段目前不完全后期可能添加新字段

字段	类型	是否必填	字段意义	备注
mobilePhone	String(11)	否	手机号
weChatCardPackage	Object<weChatCardPackage>	否	微信卡包信息

用户微信卡包信息

• JSON Key为weChatCardPackage，必填

字段	类型	是否必填	字段意义	备注
userUnionId	String(50)	否	微信用户唯一识别号
appId	String(20)	否	公众号id
userOpenId	String(50)	否	appId对应公众号下用户唯一识别号

下单制码资金渠道

• JSON Key为makeFundsChannel，非必填

字段	类型	是否必填	字段意义	备注
totalAmount	Number	是	总金额	单位：分
channelBenefit	Number	否	渠道出资优惠	单位：分
merchantBenefit	Number	否	商户出资优惠	单位：分
userRealAmount	Number	否	用户实付金额	单位：分
merchantRealAmount	Number	否	商户实收金额	单位：分

制码订单通知

接口用途

• 易百制码成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：制码通知

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	MakeCodeNotify
bizContent	JSONString<makeCodeNotify>	否	制码通知json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

制码订单作废通知

接口用途

• 易百制码订单作废成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：制码订单作废

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	MakeVoidNotify
bizContent	JSONString<makeVoidNotify>	否	制码订单作废通知json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

更新码状态通知

接口用途

• 取码方对码状态进行更新成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：码状态更新通知

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	UpdateCodeStatusNotify
bizContent	JSONString<updateCodeStatusNotify>	是	更新码状态通知json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

码延期通知

接口用途

• 取码方对码进行延期成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：码延期通知

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	CodeDelayNotify
bizContent	JSONString<codeDelayNotify>	是	码延期通知json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

码过期通知

接口用途

• 当易百自制码过期后，通知到外部。
• 每天凌晨将前一天过期的码执行通知。
• 单次通知最大支持100个串码。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：码过期通知

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	CodeExpireNotify
bizContent	JSONString<CodeExpireNotify>	是	码延期通知json字符串，Base64加密后
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

核销通知

接口用途

• 串码核销成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：串码核销

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	VerifyNotify
bizContent	JSONString<verifyNotify>	是	核销通知报文json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名

核销撤销通知

接口用途

• 串码核销撤销成功后，通知到外部。

接口说明

• 该接口为异步通知接口，对接方需要提供http接口供易百post调用。
• 签名：该报文中签名是易百私钥签名，对接方需使用易百提供的公钥进行验签。签名及验签方式详见接入说明中签名算法栏。
• bizContent中的值为Base64加密后数据，此处为了查看方便，直接引用Json对象。

请求参数，WHALE===>CHANNEL

易百标准报文：串码核销撤销

字段	类型	是否必填	字段意义	备注
appId	String(10)	是	电子凭证系统对接方id
action	String(20)	是	业务标识	VerifyVoidNotify
bizContent	JSONString<verifyVoidNotify>	是	核销撤销通知报文json字符串
version	String(10)	是	版本号
timestamp	String	是	时间戳
sign	String	是	签名