# 业务参数对象 # 资金渠道 - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`fundsChannel`,出现在返回报文中,非必填
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
totalAmount | Number | 否 | 订单总金额 | 单位:分。totalAmount = discountAmount + userRealAmount |
discountAmount | Number | 否 | 折扣金额 | 单位:分。discountAmount = merchantBenefit + channelBenefit |
merchantRealAmount | Number | 否 | 商户实收金额 | 单位:分。merchantRealAmount = totalAmount - merchantBenefit |
channelBenefit | Number | 否 | 渠道出资优惠 | 单位:分 |
merchantBenefit | Number | 否 | 商户出资优惠 | 单位:分 |
userRealAmount | Number | 否 | 用户实付金额 | 单位:分 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
remainTotalAmount | Number | 否 | 剩余订单总金额 | 单位:分。 |
remainDiscountAmount | Number | 否 | 剩余折扣金额 | 单位:分。 |
remainMerchantRealAmount | Number | 否 | 剩余商户实收金额 | 单位:分。 |
remainChannelBenefit | Number | 否 | 剩余渠道出资优惠 | 单位:分 |
remainMerchantBenefit | Number | 否 | 剩余商户出资优惠 | 单位:分 |
remainUserRealAmount | Number | 否 | 剩余用户实付金额 | 单位:分 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
totalAmount | Number | 否 | 订单总金额 | 单位:分。totalAmount = discountAmount + userRealAmount |
discountAmount | Number | 否 | 折扣金额 | 单位:分。discountAmount = merchantBenefit + channelBenefit |
merchantRealAmount | Number | 否 | 商户实收金额(A账户) | 单位:分。merchantRealAmount = totalAmount - merchantBenefit |
merchantCustomRealAmount | Number | 否 | 商户指定实收金额 | 单位:分。默认:-1。当商户制码或激活时指定实收金额,在核销时该字段与merchantRealAmount均为指定实收金额 |
channelBenefit | Number | 否 | 渠道出资优惠 | 单位:分 |
merchantBenefit | Number | 否 | 商户出资优惠 (B账户) | 单位:分 |
userRealAmount | Number | 否 | 用户实付金额 | 单位:分 |
seq | Number | 否 | 阶梯序号 | |
seqStatus | String | 否 | 阶梯状态 | 00 初始化 01 已使用 |
verifyRequestId | String | 否 | 核销流水号 | 对应当前阶梯流水号(单次订单层级) |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
totalAmount | Number | 是 | 总金额(A+B) | 单位:分 |
channelBenefit | Number | 否 | 渠道出资优惠 | 单位:分 |
merchantBenefit | Number | 否 | 商户出资优惠(B账户) | 单位:分 |
userRealAmount | Number | 否 | 用户实付金额 | 单位:分 |
merchantRealAmount | Number | 否 | 商户实收金额(A账户) | 单位:分 |
seq | Number | 否 | 阶梯序号 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
sku | String | 是 | 商品SKU | |
qty | Integer | 是 | 数量 | |
price | Number | 是 | 单价 | 单位:分 |
type | String | 是 | 商品品类 | |
spec | String | 是 | 商品规格 | |
rebateCode | String | 否 | 折扣代码 | 当收银端折扣过产品不能在后端再次折扣时在此标注 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
memberId | String | 否 | 会员ID | |
memberName | String | 否 | 会员名称 | |
grade | String | 否 | 会员等级 | |
status | String | 否 | 会员状态 | |
memberCode | String | 否 | 会员号码 | |
balance | Long | 否 | 会员余额 | 单位:分 |
pointBalance | Long | 否 | 会员积分余额 | 单位:分 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
realCode | String | 是 | 兑换码兑换后的真实串码号 | |
realTicketId | Long | 是 | 兑换码兑换后的真实券id | |
realTicketName | String | 是 | 兑换码兑换后的真实券名称 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
mobilePhone | String | 否 | 短信通知手机号 | |
weiChat | String | 否 | 微信通知openId | 暂不支持 |
aliPay | String | 否 | 支付宝通知id | 暂不支持 |
thirdUserId | String | 否 | 第三方平台用户id | 不做业务处理,仅作为参数传递 |
weChatCardPackageNotify | Object<[weChatCardPackageNotify](https://book.e-buy.com/books/e-buy-40/page/0a09c "weChatCardPackageNotify")> | 否 | 微信卡包通知 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
userUnionId | String | 否 | 微信用户唯一识别号 | |
appId | String | 否 | 公众号id | |
userOpenId | String | 否 | 微信用户唯一识别号 | |
sendChannelId | String | 否 | 渠道id | 若是易百自制码,需要调用外部渠道进行微信卡包通知时上传该字段,字段值由易百事先分配;若是第三方制码,需要调用该制码方微信靠包通知接口时,无需上传该字段 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
updatePurchaseTime | String | 否 | 修改实际购买时间 | yyyyMMddHHmmss |
updateValidEnd | String | 否 | 修改实际有效截至时间 | yyyyMMddHHmmss |
updatePurchaseOrderNum | String | 否 | 修改用户购买订单号 | |
updateMakeNotifyType | Object<[makeNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "makeNotifyType")> | 否 | 修改制码通知信息 | |
updateVerifyNotifyType | Object<[verifyNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "verifyNotifyType")> | 否 | 修改核销通知信息 | |
updateMerchantRealAmount | Long | 否 | 修改商户实收金额 | 单位:分 |
updateMemberDetail | Object<[memberDetail](https://book.e-buy.com/books/e-buy-40/page/950a4 "memberDetail")> | 否 | 修改会员信息 | |
activateShopNo | String(10) | 否 | 激活门店号 | |
activateOrg | String(10) | 否 | 激活机构 | |
remark | String(200) | 否 | 串码备注信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
codeDetail | List<[codeQueryCodeDetail](https://book.e-buy.com/books/e-buy-40/page/8cb22 "codeQueryCodeDetail")> | 否 | 码信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 是 | 码号 | |
saleChannelOrderId | String | 是 | 取码方制码订单号 | |
saleChannelName | String | 是 | 取码方名称 | |
saleChannelCode | String | 是 | 取码方code | |
sendChannelName | String | 是 | 制码方名称 | |
useTimes | Integer | 是 | 总可使用次数 | |
remainTimes | Integer | 是 | 剩余核销次数 | |
verifyTimes | Integer | 是 | 已核销次数 | |
createDate | String | 是 | 码创建日期 | yyyyMMdd |
createTime | String | 是 | 码创建时间 | yyyyMMddHHmmss |
validStart | String | 否 | 码有效开始时间 | yyyyMMddHHmmss |
validEnd | String | 否 | 码有效结束时间 | yyyyMMddHHmmss |
activateDate | String | 否 | 激活日期 | yyyyMMdd |
activateTime | String | 否 | 激活时间 | yyyyMMddHHmmss |
activateShopNo | String | 否 | 激活门店 | |
verifyDate | String | 否 | 码核销日期 | yyyyMMdd |
verifyTime | String | 否 | 码核销时间 | yyyyMMddHHmmss |
status | String | 是 | 状态 | |
statusDesc | String | 是 | 状态描述 | |
cityCheck | String | 否 | 劵所在城市是否可用 | Y可用N不可用。第三方码核销逻辑受第三方控制时,此字段无意义 |
ticketId | String | 是 | 易百活动产品id | 由于历史原因,该字段存放易百活动产品id |
whaleTicketId | String | 是 | 券id | 券系统中券批次id,例:1000000006400 |
ticketName | String | 是 | 券名称 | |
activityId | String | 是 | 活动id | |
activityName | String | 是 | 活动名称 | |
faceValue | Number | 否 | 券面值 | 单位:分 |
shopNo | String | 否 | 核销门店编号 | |
shopName | String | 否 | 核销门店名称 | |
codeRemark | String | 否 | 串码备注字段 | |
ebuyActivityProductId | String | 是 | 易百活动产品id | |
ebuyActivityProductNo | String | 否 | 易百活动产品编号 | |
fundsChannel | Object<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")> | 否 | 资金渠道 | 在制码或激活时上传的资金明细 |
remainFundsChannel | Object<[remainFundsChannel](https://book.e-buy.com/books/e-buy-40/page/2b449 "remainFundsChannel")> | 否 | 余额资金渠道 | |
fundsChannels | Array<[fundChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")> | 否 | 资金渠道列表 | 仅针对阶梯价场景 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 否 | 券码 | |
seq | Number | 否 | 阶梯序号 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelItemId | String | 是 | 取码方子订单号 | 小于32个字符 |
ticketId | Long | 否 | 券id | 一个产品对应一个券id,由易百提供。当是普通券活动时,此处必填。 |
activityId | Long | 否 | 券id | 一个组合券活动对应一个活动id,由易百提供。当是组合券活动时,此处必填。ticketId和activityId有且仅有一个上送 |
commissionDate | String | 否 | 码开启日期 | 0:当日生效,1:次日生效,-1:暂不激活,未激活状态。validDays填写时该字段必填 |
validDays | Number | 否 | 相对有效天数 | 除制码当天开始相应天数结束。validStart、validEnd组合与validDay、commissionDate组合可选其一,若全部填写以相对有效期优先;若全部不填写,码的有效期以后台配置券有效期为准 |
validStart | Number(14) | 否 | 码有效开始时间 | 该字段填写时,validEnd必填格式:yyyyMMddHHmmss |
validEnd | Number(14) | 否 | 码有效结束时间 | 该字段填写时,validStart必填格式:yyyyMMddHHmmss |
codeNum | Number | 否 | 该券制码数量 | 最小值:1,最大值:100 |
makeFundsChannels | Array<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")> | 否 | 资金渠道 | 仅针对阶梯价场景(commissionDate 不为-1) |
makeFundsChannel | Object<[makeFundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")> | 否 | 资金渠道 | 取码方是零售模式时必填 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
returnCode | String | 是 | 请求返回码 | |
returnMsg | String | 是 | 请求返回信息 | |
channelOrderId | String | 是 | 取码方订单号 | |
createDate | String | 是 | 创建日期 | yyyyMMdd |
createTime | String | 是 | 创建时间 | yyyyMMddHHmmss |
codeNum | int | 是 | 总制码数量 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelOrderId | String | 是 | 取码方订单号 | |
tradeNo | String | 是 | 易百交易编号 | |
createDate | String | 是 | 创建日期 | yyyyMMdd |
createTime | String | 是 | 创建时间 | yyyyMMddHHmmss |
isNotify | String | 是 | 是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功 | 0:未通知,1:已通知 |
codeNum | int | 是 | 总制码数量 | |
orderRemark | JSONString | 否 | 制码请求上送内容原样下发 | |
items | List<[makeQueryResponseItem](https://book.e-buy.com/books/e-buy-40/page/138bb "makeQueryResponseItem")> | 否 | 码信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelItemId | String | 是 | 取码方子订单号 | |
ticketId | String | 否 | 券id | |
ticketName | String | 否 | 券名称 | |
brandTicketId | String | 否 | 品牌方券id | |
thirdSendTicketId | String | 否 | 第三制码方券名称 | |
ticketUseDescription | Object<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")> | 否 | 码使用描述 | |
activityId | String | 否 | 活动id | |
activityName | String | 否 | 活动名称 | |
itemResultCode | String | 是 | 子订单返回码 | |
itemResultMsg | String | 是 | 子订单返回信息 | |
validStart | String | 是 | 码有效开始时间 | yyyyMMddHHmmss |
validEnd | String | 是 | 码有效结束时间 | yyyyMMddHHmmss |
codeDetail | List<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")> | 否 | 码详情 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
codeURL | String(100) | 是 | 码链接 | |
code | String(100) | 是 | 串码 | |
useTimes | Integer | 是 | 码可核销次数 | |
status | String(2) | 是 | 状态 | |
statusDesc | String(10) | 是 | 状态描述 | |
password | String | 否 | 显示codeURL认证密码 | 此值在某些活动需要,易百会提前告知取码方 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
originalChannelOrderId | String | 是 | 取码方订单号 | |
tradeNo | String | 是 | 易百订单号 | |
createDate | String | 是 | 撤销日期 | yyyyMMdd |
createTime | String | 是 | 撤销时间 | yyyyMMddHHmmss |
totalNum | int | 是 | 本次总撤销券码数量 | |
tradeStatus | String | 是 | 表示当前订单的所有券是否都撤销成功 | A:表示全部成功;P:表示部分成功 |
voidDetails | List<[makeVoidResponseVoidDetail](https://book.e-buy.com/books/e-buy-40/page/9a968 "makeVoidResponseVoidDetail")> | 否 | 撤销信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
ticketId | String | 是 | 券id | |
originalChannelItemId | String | 是 | 原制码子订单号 | |
voidNum | int | 是 | 子订单中撤销码数量 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百交易号 | |
requestId | String | 是 | 请求流水号 | |
currentStatus | String | 是 | 当前码状态 | |
statusDesc | String | 是 | 状态说明 | |
updateDate | String | 是 | 更新日期 | |
updateTime | String | 是 | 更新时间 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 系统内部编号 | |
requestId | String | 是 | 请求流水号 | |
saleChannelId | String | 是 | 取码方ID | |
createDate | Number(8) | 是 | 创建日期 | |
createTime | Number(14) | 是 | 创建时间 | |
codeNum | int | 是 | 激活码数量 | |
resultCode | String | 是 | 批量码激活初步校验结果 | 00成功,其他失败 |
resultMsg | String | 是 | 批量码激活初步校验结果 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
swift | String | 否 | pos流水号 | |
tid | String | 否 | 终端号 | 小于8个字符,有终端限制时必填 |
mid | String | 否 | 商户号 | 15个长度 |
cityId | String | 否 | 城市id,对接时使用ebuy城市id | 有城市限制时必须上传 |
brandId | String | 是 | 品牌id | ebuy分配 |
shopNo | String | 是 | 门店号 | |
shopName | String | 是 | 门店名称 | |
manageCompany | String | 否 | 管理公司名称 | 线下必填 |
companyId | String | 否 | 管理公司编号 | 线下必填 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
swift | String | 否 | pos流水号 | |
tid | String | 否 | 终端号 | 小于8个字符,有终端限制时必填 |
mid | String | 否 | 商户号 | 15个长度 |
cityId | String | 否 | 城市id,对接时使用ebuy城市id | 有城市限制时必须上传 |
brandId | String | 是 | 品牌id | ebuy分配 |
shopNo | String | 是 | 门店号 | |
shopName | String | 是 | 门店名称 | |
manageCompany | String | 否 | 管理公司名称 | 线下必填 |
companyId | String | 否 | 管理公司编号 | 线下必填 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百订单号 | |
resultCode | String | 是 | 制码返回码 | |
resultMsg | String | 是 | 制码返回信息 | |
saleChannelOrderId | String | 是 | 取码方订单号 | |
createDate | String | 是 | 创建日期 | yyyyMMdd |
createTime | String | 是 | 创建时间 | yyyyMMddHHmmss |
isNotify | String | 是 | 是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功 | 0:未通知,1:已通知 |
ticketId | String | 是 | 券id | |
validStart | String | 是 | 码有效开始时间 | yyyyMMddHHmmss |
validEnd | String | 是 | 码有效结束时间 | yyyyMMddHHmmss |
codeDetail | Object<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")> | 否 | 码详情 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
cashTotalAmount | Number | 否 | 原样返回 | |
code | String | 是 | 原样返回 | |
ticketId | String | 是 | 券ID | |
ticketName | String | 是 | 券名称 | |
ticketType | String | 是 | 券类型 | cashCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券) |
activityNo | String | 是 | 活动编号 | 在收银一体化时收银POS可以用此值来区别活动入账 |
activityName | String | 是 | 表示券所属活动 | |
faceValue | Number | 否 | 劵面值 | 单位分 |
thirdActivityId | String | 是 | 第三方活动id | |
returnCashParam | JSONObject | 否 | 扩展字段 | 目前适用于收银机 |
printData | String | 否 | 此值仅在易百POS上核销时需要用到 | |
fundsChannel | Object<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")> | 否 | 资金渠道 | 仅在收银一体化时用到 |
goodsDetail | Object<[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")> | 否 | 折抵产品明细 | 仅在收银一体化时用到 |
redeemCodeDetail | Object<[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")> | 否 | 兑换码明细 | 当上送的码为兑换码类型时,核销返回兑换后的真实串码信息 |
orderRemark | JSONString | 否 | 制码请求上送内容原样下发 | |
orderId | String | 否 | 销售渠道id |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
returnCode | String | 是 | 单个串码核销查询结果 | 00:成功,其他:失败。当查询结果为成功时才会有下列参数返回 |
returnMsg | String | 是 | 返回结果 | |
verifyReturnCode | String | 是 | 原核销中该码核销结果 | 00:成功,其他:失败 |
verifyReturnMsg | String | 是 | 原核销中该码核销结果 | |
code | String | 是 | 串码号 | |
saleChannelOrderId | String | 是 | 制码订单号 | |
cashTotalAmount | String | 否 | 收音机上送总金额 | 单位:分 |
ticketId | String | 是 | 券ID | |
ticketName | String | 是 | 券产品名称 | |
ticketShortName | String | 是 | 券产品短名称 | |
ebuyActivityProduceId | String | 是 | 易百活动产品id | |
ebuyActivityProduceNo | String | 是 | 易百活动产品编号 | |
activityId | String | 是 | 活动id | |
activityName | String | 是 | 表示券所属活动 | |
faceValue | String | 否 | 劵面值 | 单位:分 |
thirdActivityId | String | 是 | 第三方活动id | |
returnCashParam | JSONObject | 否 | 扩展字段 | 目前适用于收银机 |
printData | String | 否 | 此值仅在易百POS上核销时需要用到 | |
fundsChannel | Object<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")> | 否 | 资金渠道 | 仅在收银一体化时用到 |
goodsDetail | Object<[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")> | 否 | 折抵产品明细 | 仅在收银一体化时用到 |
redeemCodeDetail | Object<[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")> | 否 | 兑换码明细 | 当上送的码为兑换码类型时,核销返回兑换后的真实串码信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 是 | 劵码 | |
codeValidStart | String | 是 | 券码有效期开始时间 | |
codeValidEnd | String | 是 | 劵码有效期结束时间 | |
saleChannelCode | String | 否 | 取码方编号 | |
saleChannelName | String | 否 | 取码方名称 | |
status | String | 是 | 预核销结果 | 00成功,其他失败 |
discountAmount | String | 否 | 折抵金额 | 单位:分 |
ticketRemark | String | 否 | 券产品备注信息 | |
ticketType | String | 是 | 券类型 | cacheCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券) |
fineGrainedLimit | Object<[fineGrainedLimit](https://book.e-buy.com/books/e-buy-40/page/91831 "fineGrainedLimit")> | 是 | 最细粒度规则限制数量 | |
ticketUseDescription | Object<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")> | 否 | 券使用描述 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 是 | 原样返回 | |
saleChannelCode | String | 否 | 取码方编号 | |
saleChannelName | String | 否 | 取码方名称 | |
ticketId | String | 否 | 券ID | |
ticketName | String | 否 | 券名称 | |
activityNo | String | 否 | 活动编号 | |
activityName | String | 否 | 表示券所属活动 | |
status | String | 是 | 核销结果 | 00成功,其他失败 |
statusDesc | String | 是 | 核销结果描述 | 00成功,其他失败 |
fundsChannel | Object<[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/04025 "fundsChannel")> | 否 | 金额 | |
faceValue | Number | 否 | 劵面值 | 单位分 |
extendParam | Object | 否 | 扩展字段 | |
orderRemark | JSONString | 否 | 制码请求上送内容原样下发 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 是 | 原样返回 | |
status | String | 是 | 00撤销成功,其他失败 | |
amount | String | 是 | 金额 | |
ticketName | String | 否 | 券名称 | |
statusDesc | String | 是 | 撤销结果描述 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
ticketId | String | 否 | 券id | 组合券活动时,此处非必填 |
ticketName | String | 否 | 券名称 | 组合券活动时,此处非必填 |
thirdActivityId | String | 是 | 第三方活动id | |
activityId | String | 是 | 活动id | |
activityName | int | 是 | 活动名称 | |
activityType | int | 是 | 活动类型 | 0:普通券活动,1:组合券活动 |
activityValidStart | String | 是 | 活动开始时间 | yyyyMMddHHmmss |
activityValidEnd | String | 是 | 活动结束时间 | yyyyMMddHHmmss |
codeValidStart | String | 是 | 券所制码有效开始时间 | yyyyMMddHHmmss |
codeValidEnd | String | 是 | 券所制码有效结束时间 | yyyyMMddHHmmss |
commissionDate | String | 是 | 券启用日期 | 0:当日生效,1:次日生效 |
codeValidDay | int | 是 | 相对有效天数 | |
createDate | String | 是 | 券创建日期 | yyyyMMdd |
createTime | String | 是 | 券创建时间 | yyyyMMddHHmmss |
serviceProvider | String | 是 | 系统服务提供商 | |
sendChannelName | String | 是 | 发码方名称 | |
saleChannelName | String | 是 | 取码方名称 | |
brandNames | List | 是 | 品牌名称 | 组合券活动时,可能存在多个品牌 |
activityUseDescription | Object<[activityUseDescription](https://book.e-buy.com/books/e-buy-40/page/a4a04 "activityUseDescription")> | 是 | 活动使用说明 | |
ticketUseDescription | Object<[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")> | 是 | 券使用说明 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelItemId | String | 是 | 取码方子订单号 | 小于32个字符 |
tradeItemNo | String | 是 | 易百子订单号 | 小于32个字符 |
ticketId | Long | 否 | 券id | 若制码方可根据易百券id进行制码则上传 |
thirdProductId | Long | 否 | 制码方产品id | 若制码方只能根据制码方产品id进行制码则上传,存于券模板中 |
codeNum | Number | 是 | 该产品制码数量 | 最小值:1,最大值:100。同步制码时只能填1 |
useTimes | Number | 是 | 单码可兑换次数 | |
validStart | Number(14) | 否 | 码有效开始时间 | 该字段填写时,validEnd必填格式:yyyyMMddHHmmss |
validEnd | Number(14) | 否 | 码有效结束时间 | 该字段填写时,validStart必填格式:yyyyMMddHHmmss |
faceValue | Number | 是 | 面值 | 券模板中配置的面值 |
netValue | Number | 是 | 净值 | 制码资金渠道中的totalAmount,若取码方未上送则取券模板中默认的净值 |
needThirdQrcode | int | 是 | 是否需要第三方二维码链接 | 0:否,1:是 |
needThirdNotify | int | 是 | 是否需要第三方执行制码通知 | 0:否,1:是 |
notifyType | <[notifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "notifyType")> | 是 | 通知类型 | |
itemEncryptKey | String | 是 | 报文加密密钥 | 3DES加密时为密钥,公私钥对加密时为公钥字符串。部分制码方根据不同活动配置不同加密密钥 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelId | String | 是 | 取码方id | 需原样返回 |
sendChannelId | String | 是 | 制码方id | 需原样返回 |
sendChannelOrderId | String(64) | 是 | 制码方订单号 | 需原样返回 |
createDate | String | 是 | 创建日期 | yyyyMMdd |
createTime | String | 是 | 创建时间 | yyyyMMddHHmmss |
isNotify | String | 是 | 是否通知到用户,通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功,当是要求微信卡包时0表示推送到微信卡包未成功 | 0:未通知,1:已通知 |
codeNum | int | 是 | 总制码数量 | |
items | List<[esbMakeOrderResponseCodes](https://book.e-buy.com/books/e-buy-40/page/esb-5ys "esbMakeOrderResponseCodes")> | 否 | 码信息 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
saleChannelItemId | String | 是 | 取码方子订单号 | 需原样返回 |
tradeItemNo | String | 是 | 易百子订单号 | 小于32个字符 |
ticketId | Long | 否 | 券id | 若制码方可根据易百券id进行制码则上传 |
thirdProductId | Long | 否 | 制码方产品id | 若制码方只能根据制码方产品id进行制码则上传,存于券模板中 |
validStart | Number(14) | 否 | 码有效开始时间 | 该字段填写时,validEnd必填格式:yyyyMMddHHmmss |
validEnd | Number(14) | 否 | 码有效结束时间 | 该字段填写时,validStart必填格式:yyyyMMddHHmmss |
itemResultCode | String | 是 | 子订单返回码 | |
itemResultMsg | String | 是 | 子订单返回信息 | |
codeDetail | List<[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")> | 否 | 码详情 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
useDescription | String | 否 | 使用说明 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
ticketPicture | String | 否 | 券图片 | |
useThreshold | Long | 否 | 优惠门槛 | 消费满\*元 |
discountDescription | String | 否 | 优惠说明 | |
useDescription | String | 否 | 使用说明 | |
useRule | String | 否 | 使用规则 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
grainedKey | String | 是 | 粒度key | day,week,mouth,year,total |
limitMaxValue | Number | 是 | 最大限制值 | 该粒度下总可使用次数 |
current | Number | 是 | 当前已使用次数 | 该粒度下已使用次数,包含本次核销 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 | |
---|---|---|---|---|---|
tradeNo | String | 是 | 易百交易编号 | ||
mobilePhone | String | 是 | 用户手机号 | 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(数字签名)。") | ||
dynamicCode | String | 是 | 动态码 | tag为02时 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百交易编号 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百交易编号 | |
dynamicCode | String | 是 | 动态码 | |
[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(数字签名)。") |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百交易编号 | |
requestId | String | 是 | 请求流水号原样返回 | |
dynamicCodeList | List | 是 | 动态码列表 | |
createDate | String | 是 | 创建日期 | yyyyMMdd |
createTime | String | 是 | 创建时间 | yyyyMMddHHmmss |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
searchCode | String | 是 | 查询码 | |
codeSecret | String | 是 | 密文码 | |
codeStatus | String | 是 | 券状态 | |
statusDesc | String | 否 | 状态描述 | |
returnCode | String | 否 | 返回状态 | |
returnMsg | String | 否 | 返回信息 | |
useTimes | int | 是 | 码可使用次数 | |
validStart | String | 是 | 码有效期开始时间 | |
validEnd | String | 是 | 码有效期结束时间 | |
ticketId | String | 是 | 券id | |
activityId | String | 是 | 活动id | |
saleChannelId | String | 是 | 取码方id | |
sendChannelId | String | 是 | 制码方id |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 系统内部编号 | |
requestId | String | 是 | 请求流水号 | |
codeTotalNum | int | 是 | 待更新码数量 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 系统内部编号 | |
requestId | String | 是 | 请求流水号 | |
totalCodeNum | int | 是 | 总数量 | |
successCodeNum | int | 是 | 码更新成功数量 | |
codeUpdateResultArray | List<[codeUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/98f13 "codeUpdateCallbackData")> | 是 | 码更新结果集 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
tradeNo | String | 是 | 易百交易编号 | |
requestId | String | 是 | 原样下发 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
code | String | 是 | 券码 | |
codeMask | String | 否 | 电子券掩码 | |
codeUrl | String | 否 | 短链 | |
userTimes | Integer | 是 | 使用次数 | |
codeStatus | String | 是 | 券码状态 | |
validStart | Date | 是 | 有效期开始时间 | |
validEnd | Date | 是 | 有效期结束时间 |
字段 | 类型 | 是否必填 | 字段意义 | 备注 |
---|---|---|---|---|
purchaseOrderId | String | 否 | 用户购买订单号 |