# 业务参数对象



# 券码历史记录

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为returnData，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="width: 96.4286%; height: 411.75px;"><thead><tr style="height: 46.5938px;"><th style="width: 18.2716%; height: 46.5938px;">字段</th><th style="width: 9.50617%; height: 46.5938px;">类型</th><th style="width: 7.65432%; height: 46.5938px;">是否必填</th><th style="width: 12.2222%; height: 46.5938px;">字段意义</th><th style="width: 52.2222%; height: 46.5938px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>dateTime</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">是</td><td style="width: 12.2222%; height: 29.7969px;">交易时间</td><td style="width: 52.2222%; height: 29.7969px;">格式: yyyyMMddHHmmss</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>returnCode</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">是</td><td style="width: 12.2222%; height: 29.7969px;">返回编码</td><td style="width: 52.2222%; height: 29.7969px;">00</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2716%; height: 46.5938px;"><div><div>returnMsg</div></div></td><td style="width: 9.50617%; height: 46.5938px;">String</td><td style="width: 7.65432%; height: 46.5938px;">是</td><td style="width: 12.2222%; height: 46.5938px;">返回编码描述</td><td style="width: 52.2222%; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2716%; height: 46.5938px;"><div><div>code</div></div></td><td style="width: 9.50617%; height: 46.5938px;">String</td><td style="width: 7.65432%; height: 46.5938px;">是</td><td style="width: 12.2222%; height: 46.5938px;">券码</td><td style="width: 52.2222%; height: 46.5938px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2716%; height: 46.5938px;"><div><div>mid</div></div></td><td style="width: 9.50617%; height: 46.5938px;">String</td><td style="width: 7.65432%; height: 46.5938px;">否</td><td style="width: 12.2222%; height: 46.5938px;">商户号</td><td style="width: 52.2222%; height: 46.5938px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>shopName</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">否</td><td style="width: 12.2222%; height: 29.7969px;">门店名称</td><td style="width: 52.2222%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div><div><div>type</div></div></div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">是</td><td style="width: 12.2222%; height: 29.7969px;">交易类型</td><td style="width: 52.2222%; height: 29.7969px;">1 发码 2 核销 3 作废 4核销撤销</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div><div><div>shopNo</div></div></div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">否</td><td style="width: 12.2222%; height: 29.7969px;">门店号</td><td style="width: 52.2222%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>tid</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">否</td><td style="width: 12.2222%; height: 29.7969px;">终端号</td><td style="width: 52.2222%; height: 29.7969px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2716%; height: 46.5938px;"><div><div>swift</div></div></td><td style="width: 9.50617%; height: 46.5938px;">String</td><td style="width: 7.65432%; height: 46.5938px;">否</td><td style="width: 12.2222%; height: 46.5938px;">索引序号</td><td style="width: 52.2222%; height: 46.5938px;">  
</td></tr><tr><td style="width: 18.2716%;"><div><div>extendData</div></div></td><td style="width: 9.50617%;">[JSON](https://book.e-buy.com/books/c20ad/page/fe73f)</td><td style="width: 7.65432%;">否</td><td style="width: 12.2222%;">扩展自定义字段</td><td style="width: 52.2222%;">  
</td></tr></tbody></table>

# 资金渠道

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`fundsChannel`，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th style="width: 148px;">字段</th><th style="width: 77px;">类型</th><th style="width: 62px;">是否必填</th><th style="width: 99px;">字段意义</th><th style="width: 423px;">备注</th></tr></thead><tbody><tr><td style="width: 148px;">totalAmount</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">订单总金额</td><td style="width: 423px;">单位：分。totalAmount = discountAmount + userRealAmount</td></tr><tr><td style="width: 148px;">discountAmount</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">折扣金额</td><td style="width: 423px;">单位：分。discountAmount = merchantBenefit + channelBenefit</td></tr><tr><td style="width: 148px;">merchantRealAmount</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">商户实收金额</td><td style="width: 423px;">单位：分。merchantRealAmount = totalAmount - merchantBenefit</td></tr><tr><td style="width: 148px;">channelBenefit</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">渠道出资优惠</td><td style="width: 423px;">单位：分</td></tr><tr><td style="width: 148px;">merchantBenefit</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">商户出资优惠</td><td style="width: 423px;">单位：分</td></tr><tr><td style="width: 148px;">userRealAmount</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">用户实付金额</td><td style="width: 423px;">单位：分</td></tr></tbody></table>

# 余额资金渠道

- - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`remainFundsChannel`，出现在返回报文中，非必填
    
    <table><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>remainTotalAmount</td><td>Number</td><td>否</td><td>剩余订单总金额</td><td>单位：分。</td></tr><tr><td>remainDiscountAmount</td><td>Number</td><td>否</td><td>剩余折扣金额</td><td>单位：分。</td></tr><tr><td>remainMerchantRealAmount</td><td>Number</td><td>否</td><td>剩余商户实收金额</td><td>单位：分。</td></tr><tr><td>remainChannelBenefit</td><td>Number</td><td>否</td><td>剩余渠道出资优惠</td><td>单位：分</td></tr><tr><td>remainMerchantBenefit</td><td>Number</td><td>否</td><td>剩余商户出资优惠</td><td>单位：分</td></tr><tr><td>remainUserRealAmount</td><td>Number</td><td>否</td><td>剩余用户实付金额</td><td>单位：分</td></tr></tbody></table>

# 核销资金渠道

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`verifyFundsChannel`，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th style="width: 126px;">字段</th><th style="width: 69px;">类型</th><th style="width: 51px;">是否必填</th><th style="width: 101px;">字段意义</th><th style="width: 462px;">备注</th></tr></thead><tbody><tr><td style="width: 126px;">totalAmount</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">订单总金额</td><td style="width: 462px;">单位：分。totalAmount = discountAmount + userRealAmount</td></tr><tr><td style="width: 126px;">discountAmount</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">折扣金额</td><td style="width: 462px;">单位：分。discountAmount = merchantBenefit + channelBenefit</td></tr><tr><td style="width: 126px;">merchantRealAmount</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">商户实收金额(A账户)</td><td style="width: 462px;">单位：分。merchantRealAmount = totalAmount - merchantBenefit</td></tr><tr><td style="width: 126px;">merchantCustomRealAmount</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">商户指定实收金额</td><td style="width: 462px;">单位：分。默认：-1。当商户制码或激活时指定实收金额，在核销时该字段与merchantRealAmount均为指定实收金额</td></tr><tr><td style="width: 126px;">channelBenefit</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">渠道出资优惠</td><td style="width: 462px;">单位：分</td></tr><tr><td style="width: 126px;">merchantBenefit</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">商户出资优惠

(B账户)

</td><td style="width: 462px;">单位：分</td></tr><tr><td style="width: 126px;">userRealAmount</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">用户实付金额</td><td style="width: 462px;">单位：分</td></tr><tr><td style="width: 126px;">seq</td><td style="width: 69px;">Number</td><td style="width: 51px;">否</td><td style="width: 101px;">阶梯序号</td><td style="width: 462px;">  
</td></tr><tr><td style="width: 126px;">seqStatus</td><td style="width: 69px;">String</td><td style="width: 51px;">否</td><td style="width: 101px;">阶梯状态</td><td style="width: 462px;">00 初始化 01 已使用</td></tr><tr><td style="width: 126px;">verifyRequestId</td><td style="width: 69px;">String</td><td style="width: 51px;">否</td><td style="width: 101px;">核销流水号</td><td style="width: 462px;">对应当前阶梯流水号(单次订单层级)</td></tr></tbody></table>

# 下单制码资金渠道

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeFundsChannel`，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="width: 93.3333%;"><thead><tr><th style="width: 29.313%;">字段</th><th style="width: 13.2824%;">类型</th><th style="width: 14.1985%;">是否必填</th><th style="width: 28.855%;">字段意义</th><th style="width: 14.3511%;">备注</th></tr></thead><tbody><tr><td style="width: 29.313%;">totalAmount</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">是</td><td style="width: 28.855%;">总金额(A+B)</td><td style="width: 14.3511%;">单位：分</td></tr><tr><td style="width: 29.313%;">channelBenefit</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">否</td><td style="width: 28.855%;">渠道出资优惠</td><td style="width: 14.3511%;">单位：分</td></tr><tr><td style="width: 29.313%;">merchantBenefit</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">否</td><td style="width: 28.855%;">商户出资优惠(B账户)</td><td style="width: 14.3511%;">单位：分</td></tr><tr><td style="width: 29.313%;">userRealAmount</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">否</td><td style="width: 28.855%;">用户实付金额</td><td style="width: 14.3511%;">单位：分</td></tr><tr><td style="width: 29.313%;">merchantRealAmount</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">否</td><td style="width: 28.855%;">商户实收金额(A账户)</td><td style="width: 14.3511%;">单位：分</td></tr><tr><td style="width: 29.313%;">seq</td><td style="width: 13.2824%;">Number</td><td style="width: 14.1985%;">否</td><td style="width: 28.855%;">阶梯序号</td><td style="width: 14.3511%;">  
</td></tr></tbody></table>

# 产品明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`goodsDetail`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>sku</td><td>String</td><td>是</td><td>商品SKU</td><td> </td></tr><tr><td>qty</td><td>Integer</td><td>是</td><td>数量</td><td> </td></tr><tr><td>price</td><td>Number</td><td>是</td><td>单价</td><td>单位：分</td></tr><tr><td>type</td><td>String</td><td>是</td><td>商品品类</td><td> </td></tr><tr><td>spec</td><td>String</td><td>是</td><td>商品规格</td><td> </td></tr><tr><td>rebateCode</td><td>String</td><td>否</td><td>折扣代码</td><td>当收银端折扣过产品不能在后端再次折扣时在此标注</td></tr></tbody></table>

# 会员信息

### 码明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`memberDetail`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-m"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>memberId</td><td>String</td><td>否</td><td>会员ID</td><td> </td></tr><tr><td>memberName</td><td>String</td><td>否</td><td>会员名称</td><td> </td></tr><tr><td>grade</td><td>String</td><td>否</td><td>会员等级</td><td> </td></tr><tr><td>status</td><td>String</td><td>否</td><td>会员状态</td><td> </td></tr><tr><td>memberCode</td><td>String</td><td>否</td><td>会员号码</td><td> </td></tr><tr><td>balance</td><td>Long</td><td>否</td><td>会员余额</td><td>单位：分</td></tr><tr><td>pointBalance</td><td>Long</td><td>否</td><td>会员积分余额</td><td>单位：分</td></tr></tbody></table>

# 兑换码明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`redeemCodeDetail`，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>realCode</td><td>String</td><td>是</td><td>兑换码兑换后的真实串码号</td><td> </td></tr><tr><td>realTicketId</td><td>Long</td><td>是</td><td>兑换码兑换后的真实券id</td><td> </td></tr><tr><td>realTicketName</td><td>String</td><td>是</td><td>兑换码兑换后的真实券名称</td></tr></tbody></table>

# 用户通知类型

### 制码通知类型

- 制码时，当需要易百通知到用户，可由取码方指定通知渠道及渠道用户信息

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-m"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>mobilePhone</td><td>String</td><td>否</td><td>短信通知手机号</td><td> </td></tr><tr><td>weiChat</td><td>String</td><td>否</td><td>微信通知openId</td><td>暂不支持</td></tr><tr><td>aliPay</td><td>String</td><td>否</td><td>支付宝通知id</td><td>暂不支持</td></tr><tr><td>thirdUserId</td><td>String</td><td>否</td><td>第三方平台用户id</td><td>不做业务处理，仅作为参数传递</td></tr><tr><td>weChatCardPackageNotify</td><td>Object&lt;[weChatCardPackageNotify](https://book.e-buy.com/books/e-buy-40/page/0a09c "weChatCardPackageNotify")&gt;</td><td>否</td><td>微信卡包通知</td><td> </td></tr></tbody></table>

# 微信卡包制码通知类型

- 当取码方需要易百协助调用制码方完成微信卡包通知时，制码时上传该字段

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-u"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>userUnionId</td><td>String</td><td>否</td><td>微信用户唯一识别号</td><td> </td></tr><tr><td>appId</td><td>String</td><td>否</td><td>公众号id</td><td> </td></tr><tr><td>userOpenId</td><td>String</td><td>否</td><td>微信用户唯一识别号</td><td> </td></tr><tr><td>sendChannelId</td><td>String</td><td>否</td><td>渠道id</td><td>若是易百自制码，需要调用外部渠道进行微信卡包通知时上传该字段，字段值由易百事先分配；若是第三方制码，需要调用该制码方微信靠包通知接口时，无需上传该字段</td></tr></tbody></table>

# 码状态更新操作类型

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`updateOpts`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-u"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>updatePurchaseTime</td><td>String</td><td>否</td><td>修改实际购买时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>updateValidEnd</td><td>String</td><td>否</td><td>修改实际有效截至时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>updatePurchaseOrderNum</td><td>String</td><td>否</td><td>修改用户购买订单号</td><td> </td></tr><tr><td>updateMakeNotifyType</td><td>Object&lt;[makeNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "makeNotifyType")&gt;</td><td>否</td><td>修改制码通知信息</td><td> </td></tr><tr><td>updateVerifyNotifyType</td><td>Object&lt;[verifyNotifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "verifyNotifyType")&gt;</td><td>否</td><td>修改核销通知信息</td><td> </td></tr><tr><td>updateMerchantRealAmount</td><td>Long</td><td>否</td><td>修改商户实收金额</td><td>单位：分</td></tr><tr><td>updateMemberDetail</td><td>Object&lt;[memberDetail](https://book.e-buy.com/books/e-buy-40/page/950a4 "memberDetail")&gt;</td><td>否</td><td>修改会员信息</td><td> </td></tr><tr><td>activateShopNo</td><td>String(10)</td><td>否</td><td>激活门店号</td><td> </td></tr><tr><td>activateOrg</td><td>String(10)</td><td>否</td><td>激活机构</td><td> </td></tr><tr><td>remark</td><td>String(200)</td><td>否</td><td>串码备注信息</td></tr></tbody></table>

# 码信息查询返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeQueryResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>codeDetail</td><td>List&lt;[codeQueryCodeDetail](https://book.e-buy.com/books/e-buy-40/page/8cb22 "codeQueryCodeDetail")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

# 码明细查询

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeQueryCodeDetail`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c" style="width: 809px;"><thead><tr><th style="width: 163px;">字段</th><th style="width: 163px;">类型</th><th style="width: 52px;">是否必填</th><th style="width: 160px;">字段意义</th><th style="width: 271px;">备注</th></tr></thead><tbody><tr><td style="width: 163px;">code</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">码号</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">saleChannelOrderId</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">取码方制码订单号</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">saleChannelName</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">取码方名称</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">saleChannelCode</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">取码方code</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">sendChannelName</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">制码方名称</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">useTimes</td><td style="width: 163px;">Integer</td><td style="width: 52px;">是</td><td style="width: 160px;">总可使用次数</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">remainTimes</td><td style="width: 163px;">Integer</td><td style="width: 52px;">是</td><td style="width: 160px;">剩余核销次数</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">verifyTimes</td><td style="width: 163px;">Integer</td><td style="width: 52px;">是</td><td style="width: 160px;">已核销次数</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">createDate</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">码创建日期</td><td style="width: 271px;">yyyyMMdd</td></tr><tr><td style="width: 163px;">createTime</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">码创建时间</td><td style="width: 271px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 163px;">validStart</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">码有效开始时间</td><td style="width: 271px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 163px;">validEnd</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">码有效结束时间</td><td style="width: 271px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 163px;">activateDate</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">激活日期</td><td style="width: 271px;">yyyyMMdd</td></tr><tr><td style="width: 163px;">activateTime</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">激活时间</td><td style="width: 271px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 163px;">activateShopNo</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">激活门店</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">verifyDate</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">码核销日期</td><td style="width: 271px;">yyyyMMdd</td></tr><tr><td style="width: 163px;">verifyTime</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">码核销时间</td><td style="width: 271px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 163px;">status</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">状态</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">statusDesc</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">状态描述</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">cityCheck</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">劵所在城市是否可用</td><td style="width: 271px;">Y可用N不可用。第三方码核销逻辑受第三方控制时，此字段无意义</td></tr><tr><td style="width: 163px;">ticketId</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">易百活动产品id</td><td style="width: 271px;">由于历史原因，该字段存放易百活动产品id</td></tr><tr><td style="width: 163px;">whaleTicketId</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">券id</td><td style="width: 271px;"> 券系统中券批次id，例：1000000006400</td></tr><tr><td style="width: 163px;">ticketName</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">券名称</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">activityId</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">活动id</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">activityName</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">活动名称</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">faceValue</td><td style="width: 163px;">Number</td><td style="width: 52px;">否</td><td style="width: 160px;">券面值</td><td style="width: 271px;">单位：分</td></tr><tr><td style="width: 163px;">shopNo</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">核销门店编号</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">shopName</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">核销门店名称</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">codeRemark</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">串码备注字段</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">ebuyActivityProductId</td><td style="width: 163px;">String</td><td style="width: 52px;">是</td><td style="width: 160px;">易百活动产品id</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">ebuyActivityProductNo</td><td style="width: 163px;">String</td><td style="width: 52px;">否</td><td style="width: 160px;">易百活动产品编号</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">fundsChannel</td><td style="width: 163px;">Object&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")&gt;</td><td style="width: 52px;">否</td><td style="width: 160px;">资金渠道</td><td style="width: 271px;">在制码或激活时上传的资金明细</td></tr><tr><td style="width: 163px;">remainFundsChannel</td><td style="width: 163px;">Object&lt;[remainFundsChannel](https://book.e-buy.com/books/e-buy-40/page/2b449 "remainFundsChannel")&gt;</td><td style="width: 52px;">否</td><td style="width: 160px;">余额资金渠道</td><td style="width: 271px;"> </td></tr><tr><td style="width: 163px;">fundsChannels</td><td style="width: 163px;">Array&lt;[fundChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")&gt;</td><td style="width: 52px;">否</td><td style="width: 160px;">资金渠道列表</td><td style="width: 271px;">仅针对阶梯价场景</td></tr></tbody></table>

# 阶梯价核销券码明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为codeArr，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th style="width: 148px;">字段</th><th style="width: 77px;">类型</th><th style="width: 62px;">是否必填</th><th style="width: 99px;">字段意义</th><th style="width: 423px;">备注</th></tr></thead><tbody><tr><td style="width: 148px;">code</td><td style="width: 77px;">String</td><td style="width: 62px;">否</td><td style="width: 99px;">券码</td><td style="width: 423px;">  
</td></tr><tr><td style="width: 148px;">seq</td><td style="width: 77px;">Number</td><td style="width: 62px;">否</td><td style="width: 99px;">阶梯序号</td><td style="width: 423px;">  
</td></tr></tbody></table>

# 制码请求子订单明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`Items`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s" style="height: 484px;"><thead><tr style="height: 45px;"><th style="width: 143px; height: 45px;">字段</th><th style="width: 111px; height: 45px;">类型</th><th style="width: 51px; height: 45px;">是否必填</th><th style="width: 117px; height: 45px;">字段意义</th><th style="width: 387px; height: 45px;">备注</th></tr></thead><tbody><tr style="height: 45px;"><td style="width: 143px; height: 45px;">saleChannelItemId</td><td style="width: 111px; height: 45px;">String</td><td style="width: 51px; height: 45px;">是</td><td style="width: 117px; height: 45px;">取码方子订单号</td><td style="width: 387px; height: 45px;">小于32个字符</td></tr><tr style="height: 45px;"><td style="width: 143px; height: 45px;">ticketId</td><td style="width: 111px; height: 45px;">Long</td><td style="width: 51px; height: 45px;">否</td><td style="width: 117px; height: 45px;">券id</td><td style="width: 387px; height: 45px;">一个产品对应一个券id，由易百提供。当是普通券活动时，此处必填。</td></tr><tr style="height: 45px;"><td style="width: 143px; height: 45px;">activityId</td><td style="width: 111px; height: 45px;">Long</td><td style="width: 51px; height: 45px;">否</td><td style="width: 117px; height: 45px;">券id</td><td style="width: 387px; height: 45px;">一个组合券活动对应一个活动id，由易百提供。当是组合券活动时，此处必填。ticketId和activityId有且仅有一个上送</td></tr><tr style="height: 45px;"><td style="width: 143px; height: 45px;">commissionDate</td><td style="width: 111px; height: 45px;">String</td><td style="width: 51px; height: 45px;">否</td><td style="width: 117px; height: 45px;">码开启日期</td><td style="width: 387px; height: 45px;">0：当日生效，1：次日生效，-1：暂不激活，未激活状态。validDays填写时该字段必填</td></tr><tr style="height: 61px;"><td style="width: 143px; height: 61px;">validDays</td><td style="width: 111px; height: 61px;">Number</td><td style="width: 51px; height: 61px;">否</td><td style="width: 117px; height: 61px;">相对有效天数</td><td style="width: 387px; height: 61px;">除制码当天开始相应天数结束。validStart、validEnd组合与validDay、commissionDate组合可选其一，若全部填写以相对有效期优先；若全部不填写，码的有效期以后台配置券有效期为准</td></tr><tr style="height: 45px;"><td style="width: 143px; height: 45px;">validStart</td><td style="width: 111px; height: 45px;">Number(14)</td><td style="width: 51px; height: 45px;">否</td><td style="width: 117px; height: 45px;">码有效开始时间</td><td style="width: 387px; height: 45px;">该字段填写时，validEnd必填格式:yyyyMMddHHmmss</td></tr><tr style="height: 45px;"><td style="width: 143px; height: 45px;">validEnd</td><td style="width: 111px; height: 45px;">Number(14)</td><td style="width: 51px; height: 45px;">否</td><td style="width: 117px; height: 45px;">码有效结束时间</td><td style="width: 387px; height: 45px;">该字段填写时，validStart必填格式:yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 143px; height: 29px;">codeNum</td><td style="width: 111px; height: 29px;">Number</td><td style="width: 51px; height: 29px;">否</td><td style="width: 117px; height: 29px;">该券制码数量</td><td style="width: 387px; height: 29px;">最小值：1，最大值：100</td></tr><tr><td style="width: 143px;">makeFundsChannels</td><td style="width: 111px;">Array&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")&gt;</td><td style="width: 51px;">否</td><td style="width: 117px;">资金渠道</td><td style="width: 387px;">仅针对阶梯价场景（commissionDate 不为-1）

</td></tr><tr style="height: 79px;"><td style="width: 143px; height: 79px;">makeFundsChannel</td><td style="width: 111px; height: 79px;">Object&lt;[makeFundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")&gt;</td><td style="width: 51px; height: 79px;">否</td><td style="width: 117px; height: 79px;">资金渠道</td><td style="width: 387px; height: 79px;">取码方是零售模式时必填

</td></tr></tbody></table>

# 批量制码订单明细返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchMakeCodeResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>returnCode</td><td>String</td><td>是</td><td>请求返回码</td><td> </td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>channelOrderId</td><td>String</td><td>是</td><td>取码方订单号</td><td> </td></tr><tr><td>createDate</td><td>String</td><td>是</td><td>创建日期</td><td>yyyyMMdd</td></tr><tr><td>createTime</td><td>String</td><td>是</td><td>创建时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>codeNum</td><td>int</td><td>是</td><td>总制码数量</td></tr></tbody></table>

# 制码/制码查询返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeQueryResponseData`，必填 <table><thead><tr><th style="width: 147px;">字段</th><th style="width: 127px;">类型</th><th style="width: 46px;">是否必填</th><th style="width: 358px;">字段意义</th><th style="width: 87px;">备注</th></tr></thead><tbody><tr><td style="width: 147px;">saleChannelOrderId</td><td style="width: 127px;">String</td><td style="width: 46px;">是</td><td style="width: 358px;">取码方订单号</td><td style="width: 87px;"> </td></tr><tr><td style="width: 147px;">tradeNo</td><td style="width: 127px;">String</td><td style="width: 46px;">是</td><td style="width: 358px;">易百交易编号</td><td style="width: 87px;"> </td></tr><tr><td style="width: 147px;">createDate</td><td style="width: 127px;">String</td><td style="width: 46px;">是</td><td style="width: 358px;">创建日期</td><td style="width: 87px;">yyyyMMdd</td></tr><tr><td style="width: 147px;">createTime</td><td style="width: 127px;">String</td><td style="width: 46px;">是</td><td style="width: 358px;">创建时间</td><td style="width: 87px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 147px;">isNotify</td><td style="width: 127px;">String</td><td style="width: 46px;">是</td><td style="width: 358px;">是否通知到用户，通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功，当是要求微信卡包时0表示推送到微信卡包未成功</td><td style="width: 87px;">0：未通知，1：已通知</td></tr><tr><td style="width: 147px;">codeNum</td><td style="width: 127px;">int</td><td style="width: 46px;">是</td><td style="width: 358px;">总制码数量</td><td style="width: 87px;"> </td></tr><tr><td style="width: 147px;">orderRemark</td><td style="width: 127px;">JSONString</td><td style="width: 46px;">否</td><td style="width: 358px;">制码请求上送内容原样下发</td></tr><tr><td style="width: 147px;">items</td><td style="width: 127px;">List&lt;[makeQueryResponseItem](https://book.e-buy.com/books/e-buy-40/page/138bb "makeQueryResponseItem")&gt;</td><td style="width: 46px;">否</td><td style="width: 358px;">码信息</td></tr></tbody></table>

# 制码/制码查询返回明细

### 制码订单查询明细返回

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeQueryResponseItem`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>saleChannelItemId</td><td>String</td><td>是</td><td>取码方子订单号</td><td> </td></tr><tr><td>ticketId</td><td>String</td><td>否</td><td>券id</td><td> </td></tr><tr><td>ticketName</td><td>String</td><td>否</td><td>券名称</td><td> </td></tr><tr><td>brandTicketId</td><td>String</td><td>否</td><td>品牌方券id</td><td> </td></tr><tr><td>thirdSendTicketId</td><td>String</td><td>否</td><td>第三制码方券名称</td><td> </td></tr><tr><td>ticketUseDescription</td><td>Object&lt;[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")&gt;</td><td>否</td><td>码使用描述</td><td> </td></tr><tr><td>activityId</td><td>String</td><td>否</td><td>活动id</td><td> </td></tr><tr><td>activityName</td><td>String</td><td>否</td><td>活动名称</td><td> </td></tr><tr><td>itemResultCode</td><td>String</td><td>是</td><td>子订单返回码</td><td> </td></tr><tr><td>itemResultMsg</td><td>String</td><td>是</td><td>子订单返回信息</td><td> </td></tr><tr><td>validStart</td><td>String</td><td>是</td><td>码有效开始时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>validEnd</td><td>String</td><td>是</td><td>码有效结束时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>codeDetail</td><td>List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")&gt;</td><td>否</td><td>码详情</td></tr></tbody></table>

# 制码/制码查询返回码明细

### 订单券码明细返回

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeOrderResponseCodeDetail`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>codeURL</td><td>String(100)</td><td>是</td><td>码链接</td><td> </td></tr><tr><td>code</td><td>String(100)</td><td>是</td><td>串码</td><td> </td></tr><tr><td>useTimes</td><td>Integer</td><td>是</td><td>码可核销次数</td><td> </td></tr><tr><td>status</td><td>String(2)</td><td>是</td><td>状态</td><td> </td></tr><tr><td>statusDesc</td><td>String(10)</td><td>是</td><td>状态描述</td><td> </td></tr><tr><td>password</td><td>String</td><td>否</td><td>显示codeURL认证密码</td><td>此值在某些活动需要，易百会提前告知取码方</td></tr></tbody></table>

# 制码撤销返回数据

### 制码订单返回码数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeVoidResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-o"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>originalChannelOrderId</td><td>String</td><td>是</td><td>取码方订单号</td><td> </td></tr><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百订单号</td><td> </td></tr><tr><td>createDate</td><td>String</td><td>是</td><td>撤销日期</td><td>yyyyMMdd</td></tr><tr><td>createTime</td><td>String</td><td>是</td><td>撤销时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>totalNum</td><td>int</td><td>是</td><td>本次总撤销券码数量</td><td> </td></tr><tr><td>tradeStatus</td><td>String</td><td>是</td><td>表示当前订单的所有券是否都撤销成功</td><td>A:表示全部成功;P:表示部分成功</td></tr><tr><td>voidDetails</td><td>List&lt;[makeVoidResponseVoidDetail](https://book.e-buy.com/books/e-buy-40/page/9a968 "makeVoidResponseVoidDetail")&gt;</td><td>否</td><td>撤销信息</td></tr></tbody></table>

# 制码撤销返回明细

### 制码订单返回码

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`makeVoidResponseVoidDetail`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>ticketId</td><td>String</td><td>是</td><td>券id</td><td> </td></tr><tr><td>originalChannelItemId</td><td>String</td><td>是</td><td>原制码子订单号</td><td> </td></tr><tr><td>voidNum</td><td>int</td><td>是</td><td>子订单中撤销码数量</td></tr></tbody></table>

# 码状态更新返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`statusUpdateData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td> </td></tr><tr><td>currentStatus</td><td>String</td><td>是</td><td>当前码状态</td><td> </td></tr><tr><td>statusDesc</td><td>String</td><td>是</td><td>状态说明</td><td> </td></tr><tr><td>updateDate</td><td>String</td><td>是</td><td>更新日期</td><td> </td></tr><tr><td>updateTime</td><td>String</td><td>是</td><td>更新时间</td></tr></tbody></table>

# 批量码激活同步返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeActivateResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>系统内部编号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td> </td></tr><tr><td>saleChannelId</td><td>String</td><td>是</td><td>取码方ID</td><td> </td></tr><tr><td>createDate</td><td>Number(8)</td><td>是</td><td>创建日期</td><td> </td></tr><tr><td>createTime</td><td>Number(14)</td><td>是</td><td>创建时间</td><td> </td></tr><tr><td>codeNum</td><td>int</td><td>是</td><td>激活码数量</td><td> </td></tr><tr><td>resultCode</td><td>String</td><td>是</td><td>批量码激活初步校验结果</td><td>00成功，其他失败</td></tr><tr><td>resultMsg</td><td>String</td><td>是</td><td>批量码激活初步校验结果</td></tr></tbody></table>

# 门店信息

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`storeInfo`此信息为线下门店核销时上送

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>swift</td><td>String</td><td>否</td><td>pos流水号</td><td> </td></tr><tr><td>tid</td><td>String</td><td>否</td><td>终端号</td><td>小于8个字符，有终端限制时必填</td></tr><tr><td>mid</td><td>String</td><td>否</td><td>商户号</td><td>15个长度</td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>城市id，对接时使用ebuy城市id</td><td>有城市限制时必须上传</td></tr><tr><td>brandId</td><td>String</td><td>是</td><td>品牌id</td><td>ebuy分配</td></tr><tr><td>shopNo</td><td>String</td><td>是</td><td>门店号</td><td> </td></tr><tr><td>shopName</td><td>String</td><td>是</td><td>门店名称</td><td> </td></tr><tr><td>manageCompany</td><td>String</td><td>否</td><td>管理公司名称</td><td>线下必填</td></tr><tr><td>companyId</td><td>String</td><td>否</td><td>管理公司编号</td><td>线下必填</td></tr></tbody></table>

# 查询时门店信息

- - [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`storeInfo`此信息为线下门店核销时上送
    
    <table><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>swift</td><td>String</td><td>否</td><td>pos流水号</td><td> </td></tr><tr><td>tid</td><td>String</td><td>否</td><td>终端号</td><td>小于8个字符，有终端限制时必填</td></tr><tr><td>mid</td><td>String</td><td>否</td><td>商户号</td><td>15个长度</td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>城市id，对接时使用ebuy城市id</td><td>有城市限制时必须上传</td></tr><tr><td>brandId</td><td>String</td><td>是</td><td>品牌id</td><td>ebuy分配</td></tr><tr><td>shopNo</td><td>String</td><td>是</td><td>门店号</td><td> </td></tr><tr><td>shopName</td><td>String</td><td>是</td><td>门店名称</td><td> </td></tr><tr><td>manageCompany</td><td>String</td><td>否</td><td>管理公司名称</td><td>线下必填</td></tr><tr><td>companyId</td><td>String</td><td>否</td><td>管理公司编号</td><td>线下必填</td></tr></tbody></table>

# 单码返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`singleMakeOrderResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th style="width: 86px;">字段</th><th style="width: 89px;">类型</th><th style="width: 53px;">是否必填</th><th style="width: 467px;">字段意义</th><th style="width: 114px;">备注</th></tr></thead><tbody><tr><td style="width: 86px;">tradeNo</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">易百订单号</td><td style="width: 114px;"> </td></tr><tr><td style="width: 86px;">resultCode</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">制码返回码</td><td style="width: 114px;"> </td></tr><tr><td style="width: 86px;">resultMsg</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">制码返回信息</td><td style="width: 114px;"> </td></tr><tr><td style="width: 86px;">saleChannelOrderId</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">取码方订单号</td><td style="width: 114px;"> </td></tr><tr><td style="width: 86px;">createDate</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">创建日期</td><td style="width: 114px;">yyyyMMdd</td></tr><tr><td style="width: 86px;">createTime</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">创建时间</td><td style="width: 114px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 86px;">isNotify</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">是否通知到用户，通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功，当是要求微信卡包时0表示推送到微信卡包未成功</td><td style="width: 114px;">0：未通知，1：已通知</td></tr><tr><td style="width: 86px;">ticketId</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">券id</td><td style="width: 114px;"> </td></tr><tr><td style="width: 86px;">validStart</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">码有效开始时间</td><td style="width: 114px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 86px;">validEnd</td><td style="width: 89px;">String</td><td style="width: 53px;">是</td><td style="width: 467px;">码有效结束时间</td><td style="width: 114px;">yyyyMMddHHmmss</td></tr><tr><td style="width: 86px;">codeDetail</td><td style="width: 89px;">Object&lt;[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")&gt;</td><td style="width: 53px;">否</td><td style="width: 467px;">码详情</td></tr></tbody></table>

# 券码核销返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeVerifyResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c" style="width: 809px;"><thead><tr><th style="width: 131px;">字段</th><th style="width: 121px;">类型</th><th style="width: 42px;">是否必填</th><th style="width: 164px;">字段意义</th><th style="width: 351px;">备注</th></tr></thead><tbody><tr><td style="width: 131px;">cashTotalAmount</td><td style="width: 121px;">Number</td><td style="width: 42px;">否</td><td style="width: 164px;">原样返回</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">code</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">原样返回</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">ticketId</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">券ID</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">ticketName</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">券名称</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">ticketType</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">券类型</td><td style="width: 351px;">cashCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券)</td></tr><tr><td style="width: 131px;">activityNo</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">活动编号</td><td style="width: 351px;">在收银一体化时收银POS可以用此值来区别活动入账</td></tr><tr><td style="width: 131px;">activityName</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">表示券所属活动</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">faceValue</td><td style="width: 121px;">Number</td><td style="width: 42px;">否</td><td style="width: 164px;">劵面值</td><td style="width: 351px;">单位分</td></tr><tr><td style="width: 131px;">thirdActivityId</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">第三方活动id</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">returnCashParam</td><td style="width: 121px;">JSONObject</td><td style="width: 42px;">否</td><td style="width: 164px;">扩展字段</td><td style="width: 351px;">目前适用于收银机</td></tr><tr><td style="width: 131px;">printData</td><td style="width: 121px;">String</td><td style="width: 42px;">否</td><td style="width: 164px;">此值仅在易百POS上核销时需要用到</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">fundsChannel</td><td style="width: 121px;">Object&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")&gt;</td><td style="width: 42px;">否</td><td style="width: 164px;">资金渠道</td><td style="width: 351px;">仅在收银一体化时用到</td></tr><tr><td style="width: 131px;">goodsDetail</td><td style="width: 121px;">Object&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")&gt;</td><td style="width: 42px;">否</td><td style="width: 164px;">折抵产品明细</td><td style="width: 351px;">仅在收银一体化时用到</td></tr><tr><td style="width: 131px;">redeemCodeDetail</td><td style="width: 121px;">Object&lt;[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")&gt;</td><td style="width: 42px;">否</td><td style="width: 164px;">兑换码明细</td><td style="width: 351px;">当上送的码为兑换码类型时，核销返回兑换后的真实串码信息</td></tr><tr><td style="width: 131px;">orderRemark</td><td style="width: 121px;">JSONString</td><td style="width: 42px;">否</td><td style="width: 164px;">制码请求上送内容原样下发</td><td style="width: 351px;">  
</td></tr><tr><td style="width: 131px;">orderId</td><td style="width: 121px;">String</td><td style="width: 42px;">否</td><td style="width: 164px;">销售渠道id</td><td style="width: 351px;">  
</td></tr></tbody></table>

# 券码核销查询返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeVerifyQueryResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-r"><thead><tr><th style="width: 254px;">字段</th><th style="width: 93px;">类型</th><th style="width: 42px;">是否必填</th><th style="width: 169px;">字段意义</th><th style="width: 251px;">备注</th></tr></thead><tbody><tr><td style="width: 254px;">returnCode</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">单个串码核销查询结果</td><td style="width: 251px;">00：成功，其他：失败。当查询结果为成功时才会有下列参数返回</td></tr><tr><td style="width: 254px;">returnMsg</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">返回结果</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">verifyReturnCode</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">原核销中该码核销结果</td><td style="width: 251px;">00：成功，其他：失败</td></tr><tr><td style="width: 254px;">verifyReturnMsg</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">原核销中该码核销结果</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">code</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">串码号</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">saleChannelOrderId</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">制码订单号</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">cashTotalAmount</td><td style="width: 93px;">String</td><td style="width: 42px;">否</td><td style="width: 169px;">收音机上送总金额</td><td style="width: 251px;">单位：分</td></tr><tr><td style="width: 254px;">ticketId</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">券ID</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">ticketName</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">券产品名称</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">ticketShortName</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">券产品短名称</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">ebuyActivityProduceId</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">易百活动产品id</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">ebuyActivityProduceNo</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">易百活动产品编号</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">activityId</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">活动id</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">activityName</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">表示券所属活动</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">faceValue</td><td style="width: 93px;">String</td><td style="width: 42px;">否</td><td style="width: 169px;">劵面值</td><td style="width: 251px;">单位：分</td></tr><tr><td style="width: 254px;">thirdActivityId</td><td style="width: 93px;">String</td><td style="width: 42px;">是</td><td style="width: 169px;">第三方活动id</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">returnCashParam</td><td style="width: 93px;">JSONObject</td><td style="width: 42px;">否</td><td style="width: 169px;">扩展字段</td><td style="width: 251px;">目前适用于收银机</td></tr><tr><td style="width: 254px;">printData</td><td style="width: 93px;">String</td><td style="width: 42px;">否</td><td style="width: 169px;">此值仅在易百POS上核销时需要用到</td><td style="width: 251px;"> </td></tr><tr><td style="width: 254px;">fundsChannel</td><td style="width: 93px;">Object&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/0777d "fundsChannel")&gt;</td><td style="width: 42px;">否</td><td style="width: 169px;">资金渠道</td><td style="width: 251px;">仅在收银一体化时用到</td></tr><tr><td style="width: 254px;">goodsDetail</td><td style="width: 93px;">Object&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/fb7b9 "goodsDetail")&gt;</td><td style="width: 42px;">否</td><td style="width: 169px;">折抵产品明细</td><td style="width: 251px;">仅在收银一体化时用到</td></tr><tr><td style="width: 254px;">redeemCodeDetail</td><td style="width: 93px;">Object&lt;[redeemCodeDetail](https://book.e-buy.com/books/e-buy-40/page/060ad "redeemCodeDetail")&gt;</td><td style="width: 42px;">否</td><td style="width: 169px;">兑换码明细</td><td style="width: 251px;">当上送的码为兑换码类型时，核销返回兑换后的真实串码信息</td></tr></tbody></table>

# 预核销返回数据

### 预核销明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeCheckResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>劵码</td><td> </td></tr><tr><td>codeValidStart</td><td>String</td><td>是</td><td>券码有效期开始时间</td><td> </td></tr><tr><td>codeValidEnd</td><td>String</td><td>是</td><td>劵码有效期结束时间</td><td> </td></tr><tr><td>saleChannelCode</td><td>String</td><td>否</td><td>取码方编号</td><td> </td></tr><tr><td>saleChannelName</td><td>String</td><td>否</td><td>取码方名称</td><td> </td></tr><tr><td>status</td><td>String</td><td>是</td><td>预核销结果</td><td>00成功，其他失败</td></tr><tr><td>discountAmount</td><td>String</td><td>否</td><td>折抵金额</td><td>单位：分</td></tr><tr><td>ticketRemark</td><td>String</td><td>否</td><td>券产品备注信息</td><td> </td></tr><tr><td>ticketType</td><td>String</td><td>是</td><td>券类型</td><td>cacheCoupon(代金券),merchandiseCoupon(商品券),discountCoupon(折扣券),fullReduceCoupon(满减券),buyGetCoupon(买赠券),redeemCoupon(兑换券)</td></tr><tr><td>fineGrainedLimit</td><td>Object&lt;[fineGrainedLimit](https://book.e-buy.com/books/e-buy-40/page/91831 "fineGrainedLimit")&gt;</td><td>是</td><td>最细粒度规则限制数量</td><td> </td></tr><tr><td>ticketUseDescription</td><td>Object&lt;[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")&gt;</td><td>否</td><td>券使用描述</td></tr></tbody></table>

# 券码批量核销明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVerifyResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c" style="height: 383px; width: 619px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 133px;">字段</th><th style="height: 29px; width: 166px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 115px;">字段意义</th><th style="height: 29px; width: 132px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 133px;">code</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 115px;">原样返回</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">saleChannelCode</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">取码方编号</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">saleChannelName</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">取码方名称</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">ticketId</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">券ID</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">ticketName</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">券名称</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">activityNo</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">活动编号</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">activityName</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">表示券所属活动</td><td style="height: 29px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">status</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 115px;">核销结果</td><td style="height: 29px; width: 132px;">00成功，其他失败</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">statusDesc</td><td style="height: 29px; width: 166px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 115px;">核销结果描述</td><td style="height: 29px; width: 132px;">00成功，其他失败</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 133px;">fundsChannel</td><td style="height: 35px; width: 166px;">Object&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/04025 "fundsChannel")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 115px;">金额</td><td style="height: 35px; width: 132px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">faceValue</td><td style="height: 29px; width: 166px;">Number</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">劵面值</td><td style="height: 29px; width: 132px;">单位分</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 133px;">extendParam</td><td style="height: 29px; width: 166px;">Object</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 115px;">扩展字段</td><td style="width: 132px;"> </td></tr><tr><td style="width: 133px;">orderRemark</td><td style="width: 166px;">JSONString</td><td style="width: 73px;">否</td><td style="width: 115px;">制码请求上送内容原样下发</td><td style="width: 132px;"> </td></tr></tbody></table>

# 批量核销撤销明细

### 券码批量核销撤销明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVerifyVoidResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>原样返回</td><td> </td></tr><tr><td>status</td><td>String</td><td>是</td><td>00撤销成功，其他失败</td><td> </td></tr><tr><td>amount</td><td>String</td><td>是</td><td>金额</td><td> </td></tr><tr><td>ticketName</td><td>String</td><td>否</td><td>券名称</td><td> </td></tr><tr><td>statusDesc</td><td>String</td><td>是</td><td>撤销结果描述</td></tr></tbody></table>

# 取码方可用券查询返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`channelTicketQueryData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>ticketId</td><td>String</td><td>否</td><td>券id</td><td>组合券活动时，此处非必填</td></tr><tr><td>ticketName</td><td>String</td><td>否</td><td>券名称</td><td>组合券活动时，此处非必填</td></tr><tr><td>thirdActivityId</td><td>String</td><td>是</td><td>第三方活动id</td><td> </td></tr><tr><td>activityId</td><td>String</td><td>是</td><td>活动id</td><td> </td></tr><tr><td>activityName</td><td>int</td><td>是</td><td>活动名称</td><td> </td></tr><tr><td>activityType</td><td>int</td><td>是</td><td>活动类型</td><td>0：普通券活动，1：组合券活动</td></tr><tr><td>activityValidStart</td><td>String</td><td>是</td><td>活动开始时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>activityValidEnd</td><td>String</td><td>是</td><td>活动结束时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>codeValidStart</td><td>String</td><td>是</td><td>券所制码有效开始时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>codeValidEnd</td><td>String</td><td>是</td><td>券所制码有效结束时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>commissionDate</td><td>String</td><td>是</td><td>券启用日期</td><td>0：当日生效，1：次日生效</td></tr><tr><td>codeValidDay</td><td>int</td><td>是</td><td>相对有效天数</td><td> </td></tr><tr><td>createDate</td><td>String</td><td>是</td><td>券创建日期</td><td>yyyyMMdd</td></tr><tr><td>createTime</td><td>String</td><td>是</td><td>券创建时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>serviceProvider</td><td>String</td><td>是</td><td>系统服务提供商</td><td> </td></tr><tr><td>sendChannelName</td><td>String</td><td>是</td><td>发码方名称</td><td> </td></tr><tr><td>saleChannelName</td><td>String</td><td>是</td><td>取码方名称</td><td> </td></tr><tr><td>brandNames</td><td>List</td><td>是</td><td>品牌名称</td><td>组合券活动时，可能存在多个品牌</td></tr><tr><td>activityUseDescription</td><td>Object&lt;[activityUseDescription](https://book.e-buy.com/books/e-buy-40/page/a4a04 "activityUseDescription")&gt;</td><td>是</td><td>活动使用说明</td><td> </td></tr><tr><td>ticketUseDescription</td><td>Object&lt;[ticketUseDescription](https://book.e-buy.com/books/e-buy-40/page/8cb22-fjz "ticketUseDescription")&gt;</td><td>是</td><td>券使用说明</td></tr></tbody></table>

# ESB制码订单明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`Items`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>saleChannelItemId</td><td>String</td><td>是</td><td>取码方子订单号</td><td>小于32个字符</td></tr><tr><td>tradeItemNo</td><td>String</td><td>是</td><td>易百子订单号</td><td>小于32个字符</td></tr><tr><td>ticketId</td><td>Long</td><td>否</td><td>券id</td><td>若制码方可根据易百券id进行制码则上传</td></tr><tr><td>thirdProductId</td><td>Long</td><td>否</td><td>制码方产品id</td><td>若制码方只能根据制码方产品id进行制码则上传，存于券模板中</td></tr><tr><td>codeNum</td><td>Number</td><td>是</td><td>该产品制码数量</td><td>最小值：1，最大值：100。同步制码时只能填1</td></tr><tr><td>useTimes</td><td>Number</td><td>是</td><td>单码可兑换次数</td><td> </td></tr><tr><td>validStart</td><td>Number(14)</td><td>否</td><td>码有效开始时间</td><td>该字段填写时，validEnd必填格式:yyyyMMddHHmmss</td></tr><tr><td>validEnd</td><td>Number(14)</td><td>否</td><td>码有效结束时间</td><td>该字段填写时，validStart必填格式:yyyyMMddHHmmss</td></tr><tr><td>faceValue</td><td>Number</td><td>是</td><td>面值</td><td>券模板中配置的面值</td></tr><tr><td>netValue</td><td>Number</td><td>是</td><td>净值</td><td>制码资金渠道中的totalAmount，若取码方未上送则取券模板中默认的净值</td></tr><tr><td>needThirdQrcode</td><td>int</td><td>是</td><td>是否需要第三方二维码链接</td><td>0：否，1：是</td></tr><tr><td>needThirdNotify</td><td>int</td><td>是</td><td>是否需要第三方执行制码通知</td><td>0：否，1：是</td></tr><tr><td>notifyType</td><td>&lt;[notifyType](https://book.e-buy.com/books/e-buy-40/page/26657 "notifyType")&gt;</td><td>是</td><td>通知类型</td><td> </td></tr><tr><td>itemEncryptKey</td><td>String</td><td>是</td><td>报文加密密钥</td><td>3DES加密时为密钥，公私钥对加密时为公钥字符串。部分制码方根据不同活动配置不同加密密钥</td></tr></tbody></table>

# ESB制码订单返回码数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`esbMakeOrderResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>saleChannelId</td><td>String</td><td>是</td><td>取码方id</td><td>需原样返回</td></tr><tr><td>sendChannelId</td><td>String</td><td>是</td><td>制码方id</td><td>需原样返回</td></tr><tr><td>sendChannelOrderId</td><td>String(64)</td><td>是</td><td>制码方订单号</td><td>需原样返回</td></tr><tr><td>createDate</td><td>String</td><td>是</td><td>创建日期</td><td>yyyyMMdd</td></tr><tr><td>createTime</td><td>String</td><td>是</td><td>创建时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>isNotify</td><td>String</td><td>是</td><td>是否通知到用户，通知形式以sendType为依据,当是要求手机短信通知时0表示短信未通知成功，当是要求微信卡包时0表示推送到微信卡包未成功</td><td>0：未通知，1：已通知</td></tr><tr><td>codeNum</td><td>int</td><td>是</td><td>总制码数量</td><td> </td></tr><tr><td>items</td><td>List&lt;[esbMakeOrderResponseCodes](https://book.e-buy.com/books/e-buy-40/page/esb-5ys "esbMakeOrderResponseCodes")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

# ESB制码返回明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`esbMakeCodeResponseItem`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>saleChannelItemId</td><td>String</td><td>是</td><td>取码方子订单号</td><td>需原样返回</td></tr><tr><td>tradeItemNo</td><td>String</td><td>是</td><td>易百子订单号</td><td>小于32个字符</td></tr><tr><td>ticketId</td><td>Long</td><td>否</td><td>券id</td><td>若制码方可根据易百券id进行制码则上传</td></tr><tr><td>thirdProductId</td><td>Long</td><td>否</td><td>制码方产品id</td><td>若制码方只能根据制码方产品id进行制码则上传，存于券模板中</td></tr><tr><td>validStart</td><td>Number(14)</td><td>否</td><td>码有效开始时间</td><td>该字段填写时，validEnd必填格式:yyyyMMddHHmmss</td></tr><tr><td>validEnd</td><td>Number(14)</td><td>否</td><td>码有效结束时间</td><td>该字段填写时，validStart必填格式:yyyyMMddHHmmss</td></tr><tr><td>itemResultCode</td><td>String</td><td>是</td><td>子订单返回码</td><td> </td></tr><tr><td>itemResultMsg</td><td>String</td><td>是</td><td>子订单返回信息</td><td> </td></tr><tr><td>codeDetail</td><td>List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-40/page/b73ce "codeDetail")&gt;</td><td>否</td><td>码详情</td></tr></tbody></table>

# 活动使用说明

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`activityUseDescription`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-u"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>useDescription</td><td>String</td><td>否</td><td>使用说明</td></tr></tbody></table>

# 券使用说明

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`ticketUseDescription`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>ticketPicture</td><td>String</td><td>否</td><td>券图片</td><td> </td></tr><tr><td>useThreshold</td><td>Long</td><td>否</td><td>优惠门槛</td><td>消费满\*元</td></tr><tr><td>discountDescription</td><td>String</td><td>否</td><td>优惠说明</td><td> </td></tr><tr><td>useDescription</td><td>String</td><td>否</td><td>使用说明</td><td> </td></tr><tr><td>useRule</td><td>String</td><td>否</td><td>使用规则</td></tr></tbody></table>

# 最细粒度规则限制数量

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`fineGrainedRuleLimit`，出现在返回报文中，非必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-g"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>grainedKey</td><td>String</td><td>是</td><td>粒度key</td><td>day,week,mouth,year,total</td></tr><tr><td>limitMaxValue</td><td>Number</td><td>是</td><td>最大限制值</td><td>该粒度下总可使用次数</td></tr><tr><td>current</td><td>Number</td><td>是</td><td>当前已使用次数</td><td>该粒度下已使用次数，包含本次核销</td></tr></tbody></table>

# 根据查询码获取手机号返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`getMobileBySearchCodeResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易编号</td><td> </td></tr><tr><td>mobilePhone</td><td>String</td><td>是</td><td>用户手机号</td><td>tag为01时</td></tr><tr><td>[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写，它定义了一种在客户端和服务器端安全传输数据的规范，通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串，它由三部分组成，第一段是 header（头部），第二段是 payload（主体信息或称为载荷），第三段是 signature（数字签名）。")</td><td>String</td><td>是</td><td>[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写，它定义了一种在客户端和服务器端安全传输数据的规范，通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串，它由三部分组成，第一段是 header（头部），第二段是 payload（主体信息或称为载荷），第三段是 signature（数字签名）。")</td><td> </td><td> </td></tr><tr><td>dynamicCode</td><td>String</td><td>是</td><td>动态码</td><td>tag为02时</td></tr></tbody></table>

# 动态码发送手机验证码返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`sendVerificationCodeResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易编号</td></tr></tbody></table>

# 校验验证码返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`checkVerificationCodeResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易编号</td><td> </td></tr><tr><td>dynamicCode</td><td>String</td><td>是</td><td>动态码</td><td> </td></tr><tr><td>[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写，它定义了一种在客户端和服务器端安全传输数据的规范，通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串，它由三部分组成，第一段是 header（头部），第二段是 payload（主体信息或称为载荷），第三段是 signature（数字签名）。")</td><td>String</td><td>是</td><td>新[jwt](https://book.e-buy.com/books/e-buy-40/page/7f100 "JWT是JSON Web Token的简写，它定义了一种在客户端和服务器端安全传输数据的规范，通过 JSON 格式来传递信息。一个JWT实际上就是一个字符串，它由三部分组成，第一段是 header（头部），第二段是 payload（主体信息或称为载荷），第三段是 signature（数字签名）。")</td><td> </td></tr></tbody></table>

# 获取动态码返回数据

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`getDynamicResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易编号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号原样返回</td><td> </td></tr><tr><td>dynamicCodeList</td><td>List</td><td>是</td><td>动态码列表</td><td> </td></tr><tr><td>createDate</td><td>String</td><td>是</td><td>创建日期</td><td>yyyyMMdd</td></tr><tr><td>createTime</td><td>String</td><td>是</td><td>创建时间</td><td>yyyyMMddHHmmss</td></tr></tbody></table>

# 码更新回调数据

### 券码批量更新回调返回明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeUpdateCallbackData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th style="width: 108px;">字段</th><th style="width: 54px;">类型</th><th style="width: 73px;">是否必填</th><th style="width: 129px;">字段意义</th><th style="width: 46px;">备注</th></tr></thead><tbody><tr><td style="width: 108px;">searchCode</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">查询码</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">codeSecret</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">密文码</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">codeStatus</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">券状态</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">statusDesc</td><td style="width: 54px;">String</td><td style="width: 73px;">否</td><td style="width: 129px;">状态描述</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">returnCode</td><td style="width: 54px;">String</td><td style="width: 73px;">否</td><td style="width: 129px;">返回状态</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">returnMsg</td><td style="width: 54px;">String</td><td style="width: 73px;">否</td><td style="width: 129px;">返回信息</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">useTimes</td><td style="width: 54px;">int</td><td style="width: 73px;">是</td><td style="width: 129px;">码可使用次数</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">validStart</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">码有效期开始时间</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">validEnd</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">码有效期结束时间</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">ticketId</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">券id</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">activityId</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">活动id</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">saleChannelId</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">取码方id</td><td style="width: 46px;"> </td></tr><tr><td style="width: 108px;">sendChannelId</td><td style="width: 54px;">String</td><td style="width: 73px;">是</td><td style="width: 129px;">制码方id</td><td style="width: 46px;"> </td></tr></tbody></table>

# 批量码更新返回数据

### 券码批量更新返回明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeUpdateResponseData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>系统内部编号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td> </td></tr><tr><td>codeTotalNum</td><td>int</td><td>是</td><td>待更新码数量</td></tr></tbody></table>

# 批量码更新回调数据

### 券码批量更新回调返回明细

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`batchCodeVoidCallbackData`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>系统内部编号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td> </td></tr><tr><td>totalCodeNum</td><td>int</td><td>是</td><td>总数量</td><td> </td></tr><tr><td>successCodeNum</td><td>int</td><td>是</td><td>码更新成功数量</td><td> </td></tr><tr><td>codeUpdateResultArray</td><td>List&lt;[codeUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/98f13 "codeUpdateCallbackData")&gt;</td><td>是</td><td>码更新结果集</td></tr></tbody></table>

# 串码通知到用户微信卡包接口同步返回报文

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`notifyCodeToCardPackageResponse`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>tradeNo</td><td>String</td><td>是</td><td>易百交易编号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>原样下发</td></tr></tbody></table>

# 第三方异步制码通知的券码信息

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为`codeFamilyInfoList`，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th style="width: 89px;">字段</th><th style="width: 61px;">类型</th><th style="width: 73px;">是否必填</th><th style="width: 86px;">字段意义</th><th style="width: 340px;">备注</th></tr></thead><tbody><tr><td style="width: 89px;">code</td><td style="width: 61px;">String</td><td style="width: 73px;">是</td><td style="width: 86px;">券码</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">codeMask</td><td style="width: 61px;">String</td><td style="width: 73px;">否</td><td style="width: 86px;">电子券掩码</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">codeUrl</td><td style="width: 61px;">String</td><td style="width: 73px;">否</td><td style="width: 86px;">短链</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">userTimes</td><td style="width: 61px;">Integer</td><td style="width: 73px;">是</td><td style="width: 86px;">使用次数</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">codeStatus</td><td style="width: 61px;">String</td><td style="width: 73px;">是</td><td style="width: 86px;">券码状态</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">validStart</td><td style="width: 61px;">Date</td><td style="width: 73px;">是</td><td style="width: 86px;">有效期开始时间</td><td style="width: 340px;"> </td></tr><tr><td style="width: 89px;">validEnd</td><td style="width: 61px;">Date</td><td style="width: 73px;">是</td><td style="width: 86px;">有效期结束时间</td><td style="width: 340px;"> </td></tr></tbody></table>

# 激活信息

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式") Key为extendData，必填

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-s"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>purchaseOrderId</td><td>String</td><td>否</td><td>用户购买订单号</td><td> </td></tr></tbody></table>

# 核销备注描述

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式")

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th style="width: 148px;">字段</th><th style="width: 77px;">类型</th><th style="width: 62px;">是否必填</th><th style="width: 99px;">字段意义</th><th style="width: 423px;">备注</th></tr></thead><tbody><tr><td style="width: 148px;">oms</td><td style="width: 77px;">String</td><td style="width: 62px;">否</td><td style="width: 99px;">OMS订单号</td><td style="width: 423px;">OMS订单号</td></tr></tbody></table>

# 二维码支付或兑换 extendData

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式")

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="width: 96.4286%; height: 411.75px;"><thead><tr style="height: 46.5938px;"><th style="width: 18.2716%; height: 46.5938px;">字段</th><th style="width: 9.50617%; height: 46.5938px;">类型</th><th style="width: 7.65432%; height: 46.5938px;">是否必填</th><th style="width: 12.2222%; height: 46.5938px;">字段意义</th><th style="width: 52.2222%; height: 46.5938px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>shopNo</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">否</td><td style="width: 12.2222%; height: 29.7969px;">门店号</td><td style="width: 52.2222%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2716%; height: 29.7969px;"><div><div>voucherNo</div></div></td><td style="width: 9.50617%; height: 29.7969px;">String</td><td style="width: 7.65432%; height: 29.7969px;">否</td><td style="width: 12.2222%; height: 29.7969px;">小票号</td><td style="width: 52.2222%; height: 29.7969px;">‌</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2716%; height: 46.5938px;"><div><div>posSerialNo</div></div></td><td style="width: 9.50617%; height: 46.5938px;">String</td><td style="width: 7.65432%; height: 46.5938px;">否</td><td style="width: 12.2222%; height: 46.5938px;">pos机号</td><td style="width: 52.2222%; height: 46.5938px;"> </td></tr></tbody></table>

# 券码历史记录扩展字段

- [JSON](https://book.e-buy.com/books/e-buy-40/page/7f100 "网络通信时的一种数据交互格式")

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="width: 96.4286%; height: 411.75px;"><thead><tr style="height: 46.5938px;"><th style="width: 18.2942%; height: 46.5938px;">字段</th><th style="width: 9.51792%; height: 46.5938px;">类型</th><th style="width: 7.66378%; height: 46.5938px;">是否必填</th><th style="width: 12.2373%; height: 46.5938px;">字段意义</th><th style="width: 52.2868%; height: 46.5938px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 18.2942%; height: 29.7969px;"><div><div>shopNo</div></div></td><td style="width: 9.51792%; height: 29.7969px;">String</td><td style="width: 7.66378%; height: 29.7969px;">否</td><td style="width: 12.2373%; height: 29.7969px;">门店号</td><td style="width: 52.2868%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 18.2942%; height: 29.7969px;"><div><div>voucherNo</div></div></td><td style="width: 9.51792%; height: 29.7969px;">String</td><td style="width: 7.66378%; height: 29.7969px;">否</td><td style="width: 12.2373%; height: 29.7969px;">小票号</td><td style="width: 52.2868%; height: 29.7969px;">‌</td></tr><tr style="height: 46.5938px;"><td style="width: 18.2942%; height: 46.5938px;"><div><div>posSerialNo</div></div></td><td style="width: 9.51792%; height: 46.5938px;">String</td><td style="width: 7.66378%; height: 46.5938px;">否</td><td style="width: 12.2373%; height: 46.5938px;">pos机号</td><td style="width: 52.2868%; height: 46.5938px;"> </td></tr><tr style="height: 46.5938px;"><td style="width: 18.2942%;">oms</td><td style="width: 9.51792%;">String</td><td style="width: 7.66378%;">否</td><td style="width: 12.2373%;">OMS订单号</td><td style="width: 52.2868%;">OMS订单号</td></tr></tbody></table>