# 业务参数对象 # 资金渠道 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`fundsChannel`,出现在返回报文中,非必填
字段类型是否必填字段意义备注
totalAmountNumber订单总金额单位:分。totalAmount = discountAmount + userRealAmount
discountAmountNumber折扣金额单位:分。discountAmount = merchantBenefit + channelBenefit
merchantRealAmountNumber商户实收金额单位:分。merchantRealAmount = totalAmount - merchantBenefit
channelBenefitNumber渠道出资优惠单位:分
merchantBenefitNumber商户出资优惠单位:分
userRealAmountNumber用户实付金额单位:分
# 余额资金渠道 - - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`remainFundsChannel`,出现在返回报文中,非必填
字段类型是否必填字段意义备注
remainTotalAmountNumber剩余订单总金额单位:分。
remainDiscountAmountNumber剩余折扣金额单位:分。
remainMerchantRealAmountNumber剩余商户实收金额单位:分。
remainChannelBenefitNumber剩余渠道出资优惠单位:分
remainMerchantBenefitNumber剩余商户出资优惠单位:分
remainUserRealAmountNumber剩余用户实付金额单位:分
# 核销资金渠道 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`verifyFundsChannel`,出现在返回报文中,非必填
字段类型是否必填字段意义备注
totalAmountNumber订单总金额单位:分。totalAmount = discountAmount + userRealAmount
discountAmountNumber折扣金额单位:分。discountAmount = merchantBenefit + channelBenefit
merchantRealAmountNumber商户实收金额(A账户)单位:分。merchantRealAmount = totalAmount - merchantBenefit
merchantCustomRealAmountNumber商户指定实收金额单位:分。默认:-1。当商户制码或激活时指定实收金额,在核销时该字段与merchantRealAmount均为指定实收金额
channelBenefitNumber渠道出资优惠单位:分
merchantBenefitNumber商户出资优惠 (B账户) 单位:分
userRealAmountNumber用户实付金额单位:分
seqNumber阶梯序号
seqStatusString阶梯状态00 初始化 01 已使用
verifyRequestIdString核销流水号对应当前阶梯流水号(单次订单层级)
# 下单制码资金渠道 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeFundsChannel`,非必填
字段类型是否必填字段意义备注
totalAmountNumber总金额(A+B)单位:分
channelBenefitNumber渠道出资优惠单位:分
merchantBenefitNumber商户出资优惠(B账户)单位:分
userRealAmountNumber用户实付金额单位:分
merchantRealAmountNumber商户实收金额(A账户)单位:分
seqNumber阶梯序号
# 产品明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`goodsDetail`,必填
字段类型是否必填字段意义备注
skuString商品SKU
qtyInteger数量
priceNumber单价单位:分
typeString商品品类
specString商品规格
rebateCodeString折扣代码当收银端折扣过产品不能在后端再次折扣时在此标注
# 会员信息 ### 码明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`memberDetail`,必填
字段类型是否必填字段意义备注
memberIdString会员ID
memberNameString会员名称
gradeString会员等级
statusString会员状态
memberCodeString会员号码
balanceLong会员余额单位:分
pointBalanceLong会员积分余额单位:分
# 兑换码明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`redeemCodeDetail`,出现在返回报文中,非必填
字段类型是否必填字段意义备注
realCodeString兑换码兑换后的真实串码号
realTicketIdLong兑换码兑换后的真实券id
realTicketNameString兑换码兑换后的真实券名称
# 用户通知类型 ### 制码通知类型 - 制码时,当需要易百通知到用户,可由取码方指定通知渠道及渠道用户信息
字段类型是否必填字段意义备注
mobilePhoneString短信通知手机号
weiChatString微信通知openId暂不支持
aliPayString支付宝通知id暂不支持
thirdUserIdString第三方平台用户id不做业务处理,仅作为参数传递
weChatCardPackageNotifyObject<[weChatCardPackageNotify](https://book.e-buy.com/books/e-buy-40/page/0a09c "weChatCardPackageNotify")>微信卡包通知
# 微信卡包制码通知类型 - 当取码方需要易百协助调用制码方完成微信卡包通知时,制码时上传该字段
字段类型是否必填字段意义备注
userUnionIdString微信用户唯一识别号
appIdString公众号id
userOpenIdString微信用户唯一识别号
sendChannelIdString渠道id若是易百自制码,需要调用外部渠道进行微信卡包通知时上传该字段,字段值由易百事先分配;若是第三方制码,需要调用该制码方微信靠包通知接口时,无需上传该字段
# 码状态更新操作类型 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`updateOpts`,必填
字段类型是否必填字段意义备注
updatePurchaseTimeString修改实际购买时间yyyyMMddHHmmss
updateValidEndString修改实际有效截至时间yyyyMMddHHmmss
updatePurchaseOrderNumString修改用户购买订单号
updateMakeNotifyTypeObject<[makeNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "makeNotifyType")>修改制码通知信息
updateVerifyNotifyTypeObject<[verifyNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "verifyNotifyType")>修改核销通知信息
updateMerchantRealAmountLong修改商户实收金额单位:分
updateMemberDetailObject<[memberDetail](https://book.e-buy.com/books/e-buy-40/page/950a4 "memberDetail")>修改会员信息
activateShopNoString(10)激活门店号
activateOrgString(10)激活机构
remarkString(200)串码备注信息
# 码信息查询返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeQueryResponseData`,必填
字段类型是否必填字段意义备注
codeDetailList<[codeQueryCodeDetail](https://book.e-buy.com/books/e-buy-40/page/8cb22 "codeQueryCodeDetail")>码信息
# 码明细查询 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeQueryCodeDetail`,必填
字段类型是否必填字段意义备注
codeString码号
saleChannelOrderIdString取码方制码订单号
saleChannelNameString取码方名称
saleChannelCodeString取码方code
sendChannelNameString制码方名称
useTimesInteger总可使用次数
remainTimesInteger剩余核销次数
verifyTimesInteger已核销次数
createDateString码创建日期yyyyMMdd
createTimeString码创建时间yyyyMMddHHmmss
validStartString码有效开始时间yyyyMMddHHmmss
validEndString码有效结束时间yyyyMMddHHmmss
activateDateString激活日期yyyyMMdd
activateTimeString激活时间yyyyMMddHHmmss
activateShopNoString激活门店
verifyDateString码核销日期yyyyMMdd
verifyTimeString码核销时间yyyyMMddHHmmss
statusString状态
statusDescString状态描述
cityCheckString劵所在城市是否可用Y可用N不可用。第三方码核销逻辑受第三方控制时,此字段无意义
ticketIdString易百活动产品id由于历史原因,该字段存放易百活动产品id
whaleTicketIdString券id 券系统中券批次id,例:1000000006400
ticketNameString券名称
activityIdString活动id
activityNameString活动名称
faceValueNumber券面值单位:分
shopNoString核销门店编号
shopNameString核销门店名称
codeRemarkString串码备注字段
ebuyActivityProductIdString易百活动产品id
ebuyActivityProductNoString易百活动产品编号
fundsChannelObject<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")>资金渠道在制码或激活时上传的资金明细
remainFundsChannelObject<[remainFundsChannel](https://book.e-buy.com/books/e-buy-40/page/2b449 "remainFundsChannel")>余额资金渠道
fundsChannelsArray<[fundChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")>资金渠道列表仅针对阶梯价场景
# 阶梯价核销券码明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为codeArr,出现在返回报文中,非必填
字段类型是否必填字段意义备注
codeString券码
seqNumber阶梯序号
# 制码请求子订单明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`Items`,必填
字段类型是否必填字段意义备注
saleChannelItemIdString取码方子订单号小于32个字符
ticketIdLong券id一个产品对应一个券id,由易百提供。当是普通券活动时,此处必填。
activityIdLong券id一个组合券活动对应一个活动id,由易百提供。当是组合券活动时,此处必填。ticketId和activityId有且仅有一个上送
commissionDateString码开启日期0:当日生效,1:次日生效,-1:暂不激活,未激活状态。validDays填写时该字段必填
validDaysNumber相对有效天数除制码当天开始相应天数结束。validStart、validEnd组合与validDay、commissionDate组合可选其一,若全部填写以相对有效期优先;若全部不填写,码的有效期以后台配置券有效期为准
validStartNumber(14)码有效开始时间该字段填写时,validEnd必填格式:yyyyMMddHHmmss
validEndNumber(14)码有效结束时间该字段填写时,validStart必填格式:yyyyMMddHHmmss
codeNumNumber该券制码数量最小值:1,最大值:100
makeFundsChannelsArray<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")>资金渠道仅针对阶梯价场景(commissionDate 不为-1)
makeFundsChannelObject<[makeFundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")>资金渠道取码方是零售模式时必填
# 批量制码订单明细返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchMakeCodeResponseData`,必填
字段类型是否必填字段意义备注
returnCodeString请求返回码
returnMsgString请求返回信息
channelOrderIdString取码方订单号
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
codeNumint总制码数量
# 制码/制码查询返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeQueryResponseData`,必填
字段类型是否必填字段意义备注
saleChannelOrderIdString取码方订单号
tradeNoString易百交易编号
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
isNotifyString是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功0:未通知,1:已通知
codeNumint总制码数量
orderRemarkJSONString制码请求上送内容原样下发
itemsList<[makeQueryResponseItem](https://book.e-buy.com/books/e-buy-40/page/138bb "makeQueryResponseItem")>码信息
# 制码/制码查询返回明细 ### 制码订单查询明细返回 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeQueryResponseItem`,必填
字段类型是否必填字段意义备注
saleChannelItemIdString取码方子订单号
ticketIdString券id
ticketNameString券名称
brandTicketIdString品牌方券id
thirdSendTicketIdString第三制码方券名称
ticketUseDescriptionObject<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")>码使用描述
activityIdString活动id
activityNameString活动名称
itemResultCodeString子订单返回码
itemResultMsgString子订单返回信息
validStartString码有效开始时间yyyyMMddHHmmss
validEndString码有效结束时间yyyyMMddHHmmss
codeDetailList<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")>码详情
# 制码/制码查询返回码明细 ### 订单券码明细返回 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeOrderResponseCodeDetail`,必填
字段类型是否必填字段意义备注
codeURLString(100)码链接
codeString(100)串码
useTimesInteger码可核销次数
statusString(2)状态
statusDescString(10)状态描述
passwordString显示codeURL认证密码此值在某些活动需要,易百会提前告知取码方
# 制码撤销返回数据 ### 制码订单返回码数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeVoidResponseData`,必填
字段类型是否必填字段意义备注
originalChannelOrderIdString取码方订单号
tradeNoString易百订单号
createDateString撤销日期yyyyMMdd
createTimeString撤销时间yyyyMMddHHmmss
totalNumint本次总撤销券码数量
tradeStatusString表示当前订单的所有券是否都撤销成功A:表示全部成功;P:表示部分成功
voidDetailsList<[makeVoidResponseVoidDetail](https://book.e-buy.com/books/e-buy-40/page/9a968 "makeVoidResponseVoidDetail")>撤销信息
# 制码撤销返回明细 ### 制码订单返回码 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeVoidResponseVoidDetail`,必填
字段类型是否必填字段意义备注
ticketIdString券id
originalChannelItemIdString原制码子订单号
voidNumint子订单中撤销码数量
# 码状态更新返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`statusUpdateData`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易号
requestIdString请求流水号
currentStatusString当前码状态
statusDescString状态说明
updateDateString更新日期
updateTimeString更新时间
# 批量码激活同步返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeActivateResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString系统内部编号
requestIdString请求流水号
saleChannelIdString取码方ID
createDateNumber(8)创建日期
createTimeNumber(14)创建时间
codeNumint激活码数量
resultCodeString批量码激活初步校验结果00成功,其他失败
resultMsgString批量码激活初步校验结果
# 门店信息 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`storeInfo`此信息为线下门店核销时上送
字段类型是否必填字段意义备注
swiftStringpos流水号
tidString终端号小于8个字符,有终端限制时必填
midString商户号15个长度
cityIdString城市id,对接时使用ebuy城市id有城市限制时必须上传
brandIdString品牌idebuy分配
shopNoString门店号
shopNameString门店名称
manageCompanyString管理公司名称线下必填
companyIdString管理公司编号线下必填
# 查询时门店信息 - - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`storeInfo`此信息为线下门店核销时上送
字段类型是否必填字段意义备注
swiftStringpos流水号
tidString终端号小于8个字符,有终端限制时必填
midString商户号15个长度
cityIdString城市id,对接时使用ebuy城市id有城市限制时必须上传
brandIdString品牌idebuy分配
shopNoString门店号
shopNameString门店名称
manageCompanyString管理公司名称线下必填
companyIdString管理公司编号线下必填
# 单码返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`singleMakeOrderResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString易百订单号
resultCodeString制码返回码
resultMsgString制码返回信息
saleChannelOrderIdString取码方订单号
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
isNotifyString是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功0:未通知,1:已通知
ticketIdString券id
validStartString码有效开始时间yyyyMMddHHmmss
validEndString码有效结束时间yyyyMMddHHmmss
codeDetailObject<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")>码详情
# 券码核销返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeVerifyResponseData`,必填
字段类型是否必填字段意义备注
cashTotalAmountNumber原样返回
codeString原样返回
ticketIdString券ID
ticketNameString券名称
ticketTypeString券类型cashCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券)
activityNoString活动编号在收银一体化时收银POS可以用此值来区别活动入账
activityNameString表示券所属活动
faceValueNumber劵面值单位分
thirdActivityIdString第三方活动id
returnCashParamJSONObject扩展字段目前适用于收银机
printDataString此值仅在易百POS上核销时需要用到
fundsChannelObject<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")>资金渠道仅在收银一体化时用到
goodsDetailObject<[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")>折抵产品明细仅在收银一体化时用到
redeemCodeDetailObject<[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")>兑换码明细当上送的码为兑换码类型时,核销返回兑换后的真实串码信息
orderRemarkJSONString制码请求上送内容原样下发
orderIdString销售渠道id
# 券码核销查询返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeVerifyQueryResponseData`,必填
字段类型是否必填字段意义备注
returnCodeString单个串码核销查询结果00:成功,其他:失败。当查询结果为成功时才会有下列参数返回
returnMsgString返回结果
verifyReturnCodeString原核销中该码核销结果00:成功,其他:失败
verifyReturnMsgString原核销中该码核销结果
codeString串码号
saleChannelOrderIdString制码订单号
cashTotalAmountString收音机上送总金额单位:分
ticketIdString券ID
ticketNameString券产品名称
ticketShortNameString券产品短名称
ebuyActivityProduceIdString易百活动产品id
ebuyActivityProduceNoString易百活动产品编号
activityIdString活动id
activityNameString表示券所属活动
faceValueString劵面值单位:分
thirdActivityIdString第三方活动id
returnCashParamJSONObject扩展字段目前适用于收银机
printDataString此值仅在易百POS上核销时需要用到
fundsChannelObject<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")>资金渠道仅在收银一体化时用到
goodsDetailObject<[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")>折抵产品明细仅在收银一体化时用到
redeemCodeDetailObject<[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")>兑换码明细当上送的码为兑换码类型时,核销返回兑换后的真实串码信息
# 预核销返回数据 ### 预核销明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeCheckResponseData`,必填
字段类型是否必填字段意义备注
codeString劵码
codeValidStartString券码有效期开始时间
codeValidEndString劵码有效期结束时间
saleChannelCodeString取码方编号
saleChannelNameString取码方名称
statusString预核销结果00成功,其他失败
discountAmountString折抵金额单位:分
ticketRemarkString券产品备注信息
ticketTypeString券类型cacheCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券)
fineGrainedLimitObject<[fineGrainedLimit](https://book.e-buy.com/books/e-buy-40/page/91831 "fineGrainedLimit")>最细粒度规则限制数量
ticketUseDescriptionObject<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")>券使用描述
# 券码批量核销明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVerifyResponseData`,必填
字段类型是否必填字段意义备注
codeString原样返回
saleChannelCodeString取码方编号
saleChannelNameString取码方名称
ticketIdString券ID
ticketNameString券名称
activityNoString活动编号
activityNameString表示券所属活动
statusString核销结果00成功,其他失败
statusDescString核销结果描述00成功,其他失败
fundsChannelObject<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/04025 "fundsChannel")>金额
faceValueNumber劵面值单位分
extendParamObject扩展字段
orderRemarkJSONString制码请求上送内容原样下发
# 批量核销撤销明细 ### 券码批量核销撤销明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVerifyVoidResponseData`,必填
字段类型是否必填字段意义备注
codeString原样返回
statusString00撤销成功,其他失败
amountString金额
ticketNameString券名称
statusDescString撤销结果描述
# 取码方可用券查询返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`channelTicketQueryData`,必填
字段类型是否必填字段意义备注
ticketIdString券id组合券活动时,此处非必填
ticketNameString券名称组合券活动时,此处非必填
thirdActivityIdString第三方活动id
activityIdString活动id
activityNameint活动名称
activityTypeint活动类型0:普通券活动,1:组合券活动
activityValidStartString活动开始时间yyyyMMddHHmmss
activityValidEndString活动结束时间yyyyMMddHHmmss
codeValidStartString券所制码有效开始时间yyyyMMddHHmmss
codeValidEndString券所制码有效结束时间yyyyMMddHHmmss
commissionDateString券启用日期0:当日生效,1:次日生效
codeValidDayint相对有效天数
createDateString券创建日期yyyyMMdd
createTimeString券创建时间yyyyMMddHHmmss
serviceProviderString系统服务提供商
sendChannelNameString发码方名称
saleChannelNameString取码方名称
brandNamesList品牌名称组合券活动时,可能存在多个品牌
activityUseDescriptionObject<[activityUseDescription](https://book.e-buy.com/books/e-buy-40/page/a4a04 "activityUseDescription")>活动使用说明
ticketUseDescriptionObject<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")>券使用说明
# ESB制码订单明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`Items`,必填
字段类型是否必填字段意义备注
saleChannelItemIdString取码方子订单号小于32个字符
tradeItemNoString易百子订单号小于32个字符
ticketIdLong券id若制码方可根据易百券id进行制码则上传
thirdProductIdLong制码方产品id若制码方只能根据制码方产品id进行制码则上传,存于券模板中
codeNumNumber该产品制码数量最小值:1,最大值:100。同步制码时只能填1
useTimesNumber单码可兑换次数
validStartNumber(14)码有效开始时间该字段填写时,validEnd必填格式:yyyyMMddHHmmss
validEndNumber(14)码有效结束时间该字段填写时,validStart必填格式:yyyyMMddHHmmss
faceValueNumber面值券模板中配置的面值
netValueNumber净值制码资金渠道中的totalAmount,若取码方未上送则取券模板中默认的净值
needThirdQrcodeint是否需要第三方二维码链接0:否,1:是
needThirdNotifyint是否需要第三方执行制码通知0:否,1:是
notifyType<[notifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "notifyType")>通知类型
itemEncryptKeyString报文加密密钥3DES加密时为密钥,公私钥对加密时为公钥字符串。部分制码方根据不同活动配置不同加密密钥
# ESB制码订单返回码数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`esbMakeOrderResponseData`,必填
字段类型是否必填字段意义备注
saleChannelIdString取码方id需原样返回
sendChannelIdString制码方id需原样返回
sendChannelOrderIdString(64)制码方订单号需原样返回
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
isNotifyString是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功0:未通知,1:已通知
codeNumint总制码数量
itemsList<[esbMakeOrderResponseCodes](https://book.e-buy.com/books/e-buy-40/page/esb-5ys "esbMakeOrderResponseCodes")>码信息
# ESB制码返回明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`esbMakeCodeResponseItem`,必填
字段类型是否必填字段意义备注
saleChannelItemIdString取码方子订单号需原样返回
tradeItemNoString易百子订单号小于32个字符
ticketIdLong券id若制码方可根据易百券id进行制码则上传
thirdProductIdLong制码方产品id若制码方只能根据制码方产品id进行制码则上传,存于券模板中
validStartNumber(14)码有效开始时间该字段填写时,validEnd必填格式:yyyyMMddHHmmss
validEndNumber(14)码有效结束时间该字段填写时,validStart必填格式:yyyyMMddHHmmss
itemResultCodeString子订单返回码
itemResultMsgString子订单返回信息
codeDetailList<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")>码详情
# 活动使用说明 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`activityUseDescription`,必填
字段类型是否必填字段意义备注
useDescriptionString使用说明
# 券使用说明 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`ticketUseDescription`,必填
字段类型是否必填字段意义备注
ticketPictureString券图片
useThresholdLong优惠门槛消费满\*元
discountDescriptionString优惠说明
useDescriptionString使用说明
useRuleString使用规则
# 最细粒度规则限制数量 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`fineGrainedRuleLimit`,出现在返回报文中,非必填
字段类型是否必填字段意义备注
grainedKeyString粒度keyday,week,mouth,year,total
limitMaxValueNumber最大限制值该粒度下总可使用次数
currentNumber当前已使用次数该粒度下已使用次数,包含本次核销
# 根据查询码获取手机号返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`getMobileBySearchCodeResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易编号
mobilePhoneString用户手机号tag为01时
[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写,它定义了一种在客户端和服务器端安全传输数据的规范,通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串,它由三部分组成,第一段是 header(头部),第二段是 payload(主体信息或称为载荷),第三段是 signature(数字签名)。")String[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写,它定义了一种在客户端和服务器端安全传输数据的规范,通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串,它由三部分组成,第一段是 header(头部),第二段是 payload(主体信息或称为载荷),第三段是 signature(数字签名)。")
dynamicCodeString动态码tag为02时
# 动态码发送手机验证码返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`sendVerificationCodeResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易编号
# 校验验证码返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`checkVerificationCodeResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易编号
dynamicCodeString动态码
[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写,它定义了一种在客户端和服务器端安全传输数据的规范,通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串,它由三部分组成,第一段是 header(头部),第二段是 payload(主体信息或称为载荷),第三段是 signature(数字签名)。")String新[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写,它定义了一种在客户端和服务器端安全传输数据的规范,通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串,它由三部分组成,第一段是 header(头部),第二段是 payload(主体信息或称为载荷),第三段是 signature(数字签名)。")
# 获取动态码返回数据 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`getDynamicResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易编号
requestIdString请求流水号原样返回
dynamicCodeListList动态码列表
createDateString创建日期yyyyMMdd
createTimeString创建时间yyyyMMddHHmmss
# 码更新回调数据 ### 券码批量更新回调返回明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeUpdateCallbackData`,必填
字段类型是否必填字段意义备注
searchCodeString查询码
codeSecretString密文码
codeStatusString券状态
statusDescString状态描述
returnCodeString返回状态
returnMsgString返回信息
useTimesint码可使用次数
validStartString码有效期开始时间
validEndString码有效期结束时间
ticketIdString券id
activityIdString活动id
saleChannelIdString取码方id
sendChannelIdString制码方id
# 批量码更新返回数据 ### 券码批量更新返回明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeUpdateResponseData`,必填
字段类型是否必填字段意义备注
tradeNoString系统内部编号
requestIdString请求流水号
codeTotalNumint待更新码数量
# 批量码更新回调数据 ### 券码批量更新回调返回明细 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVoidCallbackData`,必填
字段类型是否必填字段意义备注
tradeNoString系统内部编号
requestIdString请求流水号
totalCodeNumint总数量
successCodeNumint码更新成功数量
codeUpdateResultArrayList<[codeUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/98f13 "codeUpdateCallbackData")>码更新结果集
# 串码通知到用户微信卡包接口同步返回报文 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`notifyCodeToCardPackageResponse`,必填
字段类型是否必填字段意义备注
tradeNoString易百交易编号
requestIdString原样下发
# 第三方异步制码通知的券码信息 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeFamilyInfoList`,必填
字段类型是否必填字段意义备注
codeString券码
codeMaskString电子券掩码
codeUrlString短链
userTimesInteger使用次数
codeStatusString券码状态
validStartDate有效期开始时间
validEndDate有效期结束时间
# 激活信息 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为extendData,必填
字段类型是否必填字段意义备注
purchaseOrderIdString用户购买订单号