# 交易类接口



# 同步单条发码

#### **接口用途**

- 支持请码方一次单品请求调用,单品发码数量上限100

#### **接口说明**

- 每次调用时必须有明确的渠道订单编号。
- commissionDate = -1时，所制码不具有支付功能（即码没有激活），如果需要激活该码的支付功能需要再次调用"码激活"接口。
- 同步单条发码时，saleChannelOrderId和saleChannelItemId可用同一值。
- returnCode = "00"时，说明订单进入制码流程。itemResultCode = "00"时，说明订单制码成。
- notifyType为券码发送到用户的形式，是否需要通知以券配置为开关

#### **action**

- `MakeCode`

**请求参数，CHANNEL===>[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>saleChannelOrderId</td><td>String</td><td>是</td><td>渠道制码订单id</td><td>最长32位，当上送相同订单号时返回上一次成功信息，如果上一次请码失败，则本次会重新生成码</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>最长32位，用于标识唯一一笔交易</td></tr><tr><td>remark</td><td>JSONString</td><td>是</td><td>订单备注信息</td><td>最长200位，订单查询时原样返回</td></tr><tr><td>notifyType</td><td>Object&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>item</td><td>Object&lt;[makeOrderItems](https://book.e-buy.com/books/e-buy-40/page/3ad7c "makeOrderItems")&gt;</td><td>是</td><td>制码明细</td><td>同步制码时，仅支持单产品单码</td></tr></tbody></table>

**请求报文举例**

```
{
    "saleChannelId": "102410058",
    "saleChannelOrderId": "20181024154201",
    "requestId": "20181024154201",
    "notifyType": {
            "mobilePhone": "13524161800"
    },
    "item": {
        "saleChannelItemId":"20181024154201",
        "commissionDate":"1",
        "validDays": 10,
        "ticketId": 1,
        "makeFundsChannel": {
            "channelBenefit": 0,
            "merchantBenefit": 500,
            "userRealAmount": 2500
        }
    }
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[makeCodeResponseData](https://book.e-buy.com/books/e-buy-40/page/faa9a "makeCodeResponseData")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "saleChannelOrderId": "20181120155110",
        "tradeNo": "c1eca7fbda51430cb5100ec0699a5b00",
        "createTime": "20181120155225",
        "isNotify": "1",
        "codeNum": 1,
        "items": [{
            "codeDetail": [{
                "codeURL": "http://qrcode.url.ag/make?0000001496A382FA4725D24FA27839FC1680D136CAFE515519B94B1D&type=QRCODE",
                "code": "10116574123700278846",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            }],
            "validEnd": "20181201000000",
            "validStart": "20181121000000",
            "itemResultMsg": "SUCCESS",
            "itemResultCode": "00",
            "saleChannelItemId": "20181120155110",
            "ticketId": 9000000010,
            "ticketName":"星巴克30元代金券",
            "activityId":"1000000006",
            "activityName":"中信银行星巴克代金券活动"
        }],
        "createDate": "20181120"
    }
}
```

#### **券状态枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01" style="width: 76.5432%; height: 152.708px;"><thead><tr style="height: 46.5625px;"><th style="width: 7.26994%; height: 46.5625px;">字段</th><th style="width: 44.7505%; height: 46.5625px;">字段意义</th><th style="width: 47.9816%; height: 46.5625px;">备注</th></tr></thead><tbody><tr style="height: 29.7917px;"><td style="width: 7.26994%; height: 29.7917px;">04</td><td style="width: 44.7505%; height: 29.7917px;">参数配置不正确</td><td style="width: 47.9816%; height: 29.7917px;">RequestId参数不能为空

appId参数不能为空

</td></tr><tr style="height: 29.7917px;"><td style="width: 7.26994%; height: 29.7917px;">50</td><td style="width: 44.7505%; height: 29.7917px;">活动产品信息不存在</td><td style="width: 47.9816%; height: 29.7917px;">  
</td></tr><tr style="height: 46.5625px;"><td style="width: 7.26994%; height: 46.5625px;">97</td><td style="width: 44.7505%; height: 46.5625px;">活动产品信息不存在</td><td style="width: 47.9816%; height: 46.5625px;">活动产品信息不存在  
或者其他配置信息错误</td></tr><tr><td style="width: 7.26994%;">06</td><td style="width: 44.7505%;">活动产品未经过测试</td><td style="width: 47.9816%;">  
</td></tr><tr><td style="width: 7.26994%;">50</td><td style="width: 44.7505%;">销售渠道信息不存在</td><td style="width: 47.9816%;">  
</td></tr><tr><td style="width: 7.26994%;">07</td><td style="width: 44.7505%;">销售渠道和活动产品权限不匹配</td><td style="width: 47.9816%;">  
</td></tr></tbody></table>

# 新页面



# 新页面



# 发码订单查询

#### **接口用途**

- 当需要查询发码订单结果时，取码方调用此接口
- 当调用`同步单条发码`超时或未知状态，取码方调用此接口确认交易结果
- 此接口不支持`异步批量发码`的订单查询

#### **接口说明**

- 每一次销售渠道对接[whale](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")进行制码，生成一个制码订单。
- 制码订单以渠道方订单编号为分表位，每次调用时必须有明确的订单编号

#### **action**

- `MakeQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>原取码方制码订单id</td><td>小于64个字符</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr></tbody></table>

**请求报文举例**

```
{
    "originalChannelOrderId": "20180912162026",
    "requestId":"20180912162026"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[makeQueryResponseData](https://book.e-buy.com/books/e-buy-40/page/faa9a "makeQueryResponseData")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "saleChannelOrderId": "20181025152303",
        "tradeNo": "cee533ae3e504179868e1801e697c5dc",
        "createTime": "20181025155331",
        "isNotify": "1",
        "codeNum": 1,
        "createDate": "20181025",
        "items": [{
            "saleChannelItemId": "20181025105101",
            "itemResultMsg": "SUCCESS",
            "itemResultCode": "00",
            "validStart": "20181025155300",
            "ticketId": 1,
            "ticketName":"星巴克30元代金券",
            "activityId":"1000000006",
            "activityName":"中信银行星巴克代金券活动",
            "validEnd": "20181104155300",
            "codeDetail": [{
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQV",
                "code": "10110544106453980943",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            },
            {
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQQ",
                "code": "10110544106453980944",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            }]
        },
        {
            "saleChannelItemId": "20181025105102",
            "itemResultMsg": "SUCCESS",
            "itemResultCode": "00",
            "validStart": "20181025155300",
            "ticketId": 2,
            "ticketName":"星巴克50元代金券",
            "activityId":"1000000006",
            "activityName":"中信银行星巴克代金券活动"
            "validEnd": "20181104155300",
            "codeDetail": [{
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQV",
                "code": "10110544106453980943",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            }]
        }]
    }
}
```

# 异步批量发码

#### **接口用途**

- 电子凭证取码方需要批量(一次请求取码数超过1条)制码时，调用此接口

#### **接口说明**

- 每一次取码方对接[whale](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")进行制码，生成一个制码订单。
- 制码订单以渠道方订单编号为分表位，每次调用时必须有明确的订单编号。
- 制码请求接收后，会同步返回制码前校验结果，后端成功生成码后，异步通知到callBackUrl指定的回调接口。

#### **action**

- `MakeBatchCode`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>saleChannelOrderId</td><td>String</td><td>是</td><td>渠道制码订单id</td><td>小于64个字符</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>callBackUrl</td><td>String</td><td>是</td><td>异步结果回调地址</td><td>易百以POST请求方式推送</td></tr><tr><td>items</td><td>List&lt;[items](https://book.e-buy.com/books/e-buy-40/page/3ad7c "items")&gt;</td><td>是</td><td>制码子订单</td><td>一次制码请求最多支持10个子订单</td></tr></tbody></table>

**请求报文举例**

```
{
    "saleChannelOrderId": "20180912162026",
    "requestId": "20180912162026",
    "totalAmount": "15800",
    "notifyType": {
        "mobilePhone": "13524161800"
    },
    "callBackUrl": "http://*****/***/api",
    "items": [{
        "saleChannelItemId": "20180912162026001",
        "ticketId": 1,
        "validDays": 10,
        "validStart": "20180730000000",
        "validEnd": "20181201235959",
        "codeNum": 2,
        "makeFundsChannel": {
            "channelBenefit": 0,
            "merchantBenefit": 500,
            "userRealAmount": 2500
        }
    }, {
        "saleChannelItemId": "20180912162026002",
        "ticketId": 2,
        "validDays": 10,
        "validStart": "20180730000000",
        "validEnd": "20181201235959",
        "codeNum": 1,
        "makeFundsChannel": {
            "channelBenefit": 100,
            "merchantBenefit": 0,
            "userRealAmount": 900
        }
    }]
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>batchMakeCodeResponseData</td><td>Object&lt;[batchMakeCodeResponseData](https://book.e-buy.com/books/e-buy-40/page/a3f39 "batchMakeCodeResponseData")&gt;</td><td>否</td><td>批量制码返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "saleChannelOrderId": "201811261721",
        "saleChannelId": 99000014,
        "tradeNo": "4a784d0ec74d4211bb3c425f004f95ac",
        "createTime": "20181126172115",
        "codeNum": 5,
        "createDate": "20181126"
    }
}
```

# 批量发码结果通知

#### **接口用途**

- 异步批量下单接口所要求的码全部成功生成后，通过此接口将码信息回调到取码方

#### **接口说明**

- 接口与“异步批量发码”是一组接口来完成业务
- 此接口以[http](https://book.e-buy.com/books/e-buy-40/page/7f100 "基于HTTP协议的通讯方式") post请求方式回调取码方callBackUrl地址
- returnCode = "00"时，说明订单进入制码流程。resultCode = "00"时，说明子订单制码成。
- 如果未收到易百的回调请求，取码方可以传原订单号再次调用`异步批量发码`

**返回参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>data</td><td>Object&lt;[batchMakeCodeResponseData](https://book.e-buy.com/books/e-buy-40/page/faa9a "batchMakeCodeResponseData")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "saleChannelOrderId": "20181025152303",
        "tradeNo": "cee533ae3e504179868e1801e697c5dc",
        "createTime": "20181025155331",
        "isNotify": "1",
        "codeNum": 1,
        "createDate": "20181025",
        "items": [{
            "saleChannelItemId": "20181025105101",
            "itemResultMsg": "SUCCESS",
            "itemResultCode": "00",
            "validStart": "20181025155300",
            "ticketId": 1,
            "ticketName":"星巴克30元代金券",
            "activityId":"1000000006",
            "activityName":"中信银行星巴克代金券活动",
            "validEnd": "20181104155300",
            "codeDetail": [{
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQV",
                "code": "10110544106453980943",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            },
            {
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQQ",
                "code": "10110544106453980944",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            }]
        },
        {
            "saleChannelItemId": "20181025105102",
            "itemResultMsg": "SUCCESS",
            "itemResultCode": "00",
            "validStart": "20181025155300",
            "ticketId": 2,
            "ticketName":"星巴克50元代金券",
            "activityId":"1000000006",
            "activityName":"中信银行星巴克代金券活动"
            "validEnd": "20181104155300",
            "codeDetail": [{
                "codeURL": "http://xxxx/hbw?A3rVNNEgPLQV",
                "code": "10110544106453980943",
                "useTimes": 10,
                "status": "00",
                "statusDesc": "未使用"
            }]
        }]
    }
}
```

# 发码撤销

#### **接口用途**

- 当需要撤销某笔制码订单时，取码方调用此接口

#### **接口说明**

- 当对原制码订单进行撤销时，生成一个撤销订单。
- 对原订单进行撤销时，整单所制码都将被撤销。如需对单码撤销，调用电子凭证码状态更新接口。
- 此接口可对`同步单条发码`、`异步批量发码`下单接口订单进行撤销操作
- 对已撤销成功订单不能再次撤销
- 如果订单撤销部分成功时返回"tradeStatus"="P"
- 对订单中部分券码撤销成功时，可以按原制码订单号再次调用撤销接口，如还是部分撤销成功请联系易百技术方協助解决

#### **action**

- `MakeVoid`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>原取码方制码订单id</td><td>小于64个字符</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr></tbody></table>

**请求报文举例**

```
{
    "originalChannelOrderId": "20180912162026",
    "requestId":"20180912162026"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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" style="height: 122px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 87.0938px;">字段</th><th style="height: 29px; width: 205.594px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 101px;">字段意义</th><th style="height: 29px; width: 45px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 87.0938px;">returnCode</td><td style="height: 29px; width: 205.594px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 101px;">请求返回码</td><td style="height: 29px; width: 45px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 87.0938px;">returnMsg</td><td style="height: 29px; width: 205.594px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 101px;">请求返回信息</td><td style="height: 29px; width: 45px;"> </td></tr><tr style="height: 35px;"><td style="height: 35px; width: 87.0938px;">data</td><td style="height: 35px; width: 205.594px;">List&lt;[makeVoidResponseData](https://book.e-buy.com/books/e-buy-40/page/05f97 "makeVoidResponseData")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 101px;">码撤销信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "originalChannelOrderId": "20181018183139",
        "createDate": "20181018",
        "createTime": "20181018183454",
        "totalNum": 4,
        "tradeStatus": "A",
        "voidDetails": [{
            "ticketId": 1,
            "originalChannelItemId": "99000014001",
            "voidNum": 2
        }, {
            "ticketId": 2,
            "originalChannelItemId": "99000014002",
            "voidNum": 2
        }]
    }
}
```

# 发码撤销查询

#### **接口用途**

- 当需要查询对某笔订单的撤销结果时，取码方调用此接口

#### **接口说明**

- 当制码撤销结果未返回或因为超时等原因未能及时收到返回结果,可进行制码撤销查询

#### **action**

- `MakeVoidQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>取码方制码订单id</td><td>小于64个字符</td></tr><tr><td>orderDate</td><td>String</td><td>是</td><td>原下单日期</td><td>yyyyMMdd</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr></tbody></table>

**请求报文举例**

```
{
    "originalChannelOrderId": "20180912162026",
    "orderDate": "20180905",
    "requestId":"20180912162026"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>List&lt;[makeVoidResponseData](https://book.e-buy.com/books/e-buy-40/page/05f97 "makeVoidResponseData")&gt;</td><td>否</td><td>码撤销信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "originalChannelOrderId": "20181018183139",
        "createDate": "20181018",
        "createTime": "20181018183454",
        "totalNum": 4,
        "tradeStatus": "A",
        "voidDetails": [{
            "ticketId": 1,
            "originalChannelItemId": "99000014001",
            "voidNum": 2
        }, {
            "ticketId": 2,
            "originalChannelItemId": "99000014002",
            "voidNum": 2
        }]
    }
}
```

# 码作废（退款）接口

#### **接口用途**

- 当需要`作废`码时，取码方调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
- 已撤销(作废)/使用的码不能转换为其他状态。
- 冻结和解冻操作是相对的。

#### **action**

- `CodeStatusUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td>小于22个字符</td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>01：作废</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20181019112535100000000000000008",
    "code": "1021242013780905000",
    "optTag":"01"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "updateDate": "20241224",
        "codeSecret": "10032891673449546316",
        "codeValidEnd": "20250323235959",
        "statusDesc": "已作废",
        "data": {},
        "tradeNo": "0601f61bf54a46b8a01899b444d47a38",
        "codeValidStart": "20241224000000",
        "currentStatus": "05",
        "updateTime": "20241224093435",
        "ticketId": 1000030006397
    }
}
```

**失败返回报文举例**

```
{
    "returnCode": "32",
    "returnMsg": "流水号重复，请调用查询接口",
    "data": {}
}
```

```
{
    "returnCode": "91",
    "returnMsg": "该码已使用不能更新状态[100***8707]",
    "data": {}
}
```

```
{
    "returnCode": "91",
    "returnMsg": "该码已作废不能更新状态[100***6316]",
    "data": {}
}
```

#### **券状态枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01" style="width: 76.5432%; height: 152.734px;"><thead><tr style="height: 46.5755px;"><th style="width: 7.26994%; height: 46.5755px;">字段</th><th style="width: 44.7505%; height: 46.5755px;">字段意义</th><th style="width: 47.9816%; height: 46.5755px;">备注</th></tr></thead><tbody><tr style="height: 29.7917px;"><td style="width: 7.26994%; height: 29.7917px;">91</td><td style="width: 44.7505%; height: 29.7917px;">更新码状态不支持当前操作</td><td style="width: 47.9816%; height: 29.7917px;">更新码状态不支持当前操作</td></tr><tr style="height: 29.7917px;"><td style="width: 7.26994%; height: 29.7917px;">10</td><td style="width: 44.7505%; height: 29.7917px;">券码不存在</td><td style="width: 47.9816%; height: 29.7917px;">  
</td></tr><tr style="height: 46.5755px;"><td style="width: 7.26994%; height: 46.5755px;">02</td><td style="width: 44.7505%; height: 46.5755px;">本操作不支持，流水号长度不正确</td><td style="width: 47.9816%; height: 46.5755px;">  
</td></tr></tbody></table>

# 码冻结接口

#### **接口用途**

- 当需要`冻结`码时，取码方调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
- 已撤销(作废)/使用的码不能转换为其他状态。
- 冻结和解冻操作是相对的。

#### **action**

- `CodeStatusUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>channelOrderId</td><td>String</td><td>是</td><td>销售渠道制码订单id</td><td>小于64个字符</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td>小于22个字符</td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>02：冻结</td></tr></tbody></table>

**请求报文举例**

```
{
    "channelOrderId": "20180912162026",
    "requestId": "20181019112535100000000000000008",
    "code": "1021242013780905000",
    "optTag":"02"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "currentStatus": "01",
        "statusDesc": "已作废",
        "updateDate":"20181019",
        "updateTime":"20181019112535"
    }
}
```

# 码解冻接口

#### **接口用途**

- 当需要`解冻`码时，取码方调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
- 已撤销(作废)/使用的码不能转换为其他状态。
- 冻结和解冻操作是相对的。

#### **action**

- `CodeStatusUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>channelOrderId</td><td>String</td><td>是</td><td>销售渠道制码订单id</td><td>小于64个字符</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td>小于22个字符</td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>03：解冻</td></tr></tbody></table>

**请求报文举例**

```
{
    "channelOrderId": "20180912162026",
    "requestId": "20181019112535100000000000000008",
    "code": "1021242013780905000",
    "optTag":"03"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "currentStatus": "01",
        "statusDesc": "已作废",
        "updateDate":"20181019",
        "updateTime":"20181019112535"
    }
}
```

# 码激活接口

#### **接口用途**

- 当需要`激活`码时，取码方调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
- 已撤销(作废)/使用的码不能转换为其他状态。

#### **action**

- `CodeStatusUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td>小于22个字符</td></tr><tr><td>codeValidDays</td><td>Number</td><td>否</td><td>相对有效天数</td><td>除制码当天开始相应天数结束。validStart、validEnd组合与validDay、commissionDate组合可选其一，若全部填写以相对有效期优先</td></tr><tr><td>codeValidStart</td><td>Number(14)</td><td>否</td><td>码有效开始时间</td><td>该字段填写时，validEnd必填格式:yyyyMMddHHmmss</td></tr><tr><td>codeValidEnd</td><td>Number(14)</td><td>否</td><td>码有效结束时间</td><td>该字段填写时，validStart必填格式:yyyyMMddHHmmss</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>purchaseOrderNum</td><td>String</td><td>否</td><td>用户购买订单号</td><td>  
</td></tr><tr><td>notifyType</td><td>Object&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>makeFundsChannels</td><td>Array&lt;[fundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")&gt;</td><td>否</td><td>资金渠道</td><td>针对阶梯价场景为必填</td></tr><tr><td>makeFundsChannel</td><td>Object&lt;[makeFundsChannel](https://book.e-buy.com/books/e-buy-40/page/cee63 "makeFundsChannel")&gt;</td><td>否</td><td>资金渠道</td><td>当需要在对账报表中体现时必填</td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>04：激活</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20181019112535100000000000000008",
    "code": "1021242013780905000",
    "codeValidDays":9,
    "purchaseOrderNum":"20191119192700123",
    "optTag":"04"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "currentStatus": "00",
        "statusDesc": "未使用",
        "updateDate":"20181019",
        "updateTime":"20181019112535"
    }
}
```

**失败返回报文举例**

```
{
    "returnCode": "32",
    "returnMsg": "流水号重复，请调用查询接口",
    "data": {}
}
```

# 批量码激活

#### **接口用途**

- 多码批量激活时，调用此接口

#### **接口说明**

- 一次可以多码激活,一次最多20个码。

#### **action**

- `BatchCodeActivate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codeArray</td><td>List</td><td>是</td><td>码号数组</td><td> </td></tr><tr><td>callBackUrl</td><td>String</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>codeValidDays</td><td>Number</td><td>否</td><td>相对有效天数</td><td>除制码当天开始相应天数结束。validStart、validEnd组合与validDay、commissionDate组合可选其一，若全部填写以相对有效期优先</td></tr><tr><td>codeValidStart</td><td>Number(14)</td><td>否</td><td>码有效开始时间</td><td>该字段填写时，validEnd必填格式:yyyyMMddHHmmss</td></tr><tr><td>codeValidEnd</td><td>Number(14)</td><td>否</td><td>码有效结束时间</td><td>该字段填写时，validStart必填格式:yyyyMMddHHmmss</td></tr><tr><td>purchaseOrderNum</td><td>String</td><td>否</td><td>用户购买订单号</td><td> </td></tr><tr><td>merchantRealAmount</td><td>Number</td><td>否</td><td>用户购买时商户实收金额</td><td>单位：分</td></tr><tr><td>merchantBenefit</td><td>Number</td><td>否</td><td>用户购买时商户优惠金额</td><td>单位：分</td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>04：激活</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"20181019112535100000000000000001",
    "codeArray": ["10215523190570712621"],
    "callBackUrl": "http://test.com/api/codeActivate",
    "purchaseOrderNum":"201911191947000001",
    "optTag": "04",
}

```

**同步返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>返回码32时，请调用单码核销查询接口CodeVerifyQuery，确认核销结果</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>data/checkResult</td><td>Object&lt;[data/checkResult](https://book.e-buy.com/books/e-buy-40/page/26e35 "data")&gt;</td><td>是</td><td>批量码激活初步校验返回</td></tr></tbody></table>

**同步返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "requestId": "10000000000000000000002",
        "tradeNo": "10000000000000000000002",
        "saleChannelId":10002410,
        "createDate": "20191119",
        "createTime": "20191119200100",
        "codeNum": 1,
        "resultCode": "00",
        "resultMsg": "SUCCESS",
    }
}

```

**回调返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-1"><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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**回调返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "currentStatus": "00",
        "statusDesc": "未使用",
        "updateDate":"20181019",
        "updateTime":"20181019112535"
    }
}
```

# 批量码延期

#### **接口用途**

- 多码批量延期时，调用此接口
- 批量延期有两种方式：1.所有的码同一个有效期；2.每个码单独对应一个有效期。

#### **接口说明**

- 一次可以多码延期,一次最多1000个码。

#### **action**

- `BatchCodeUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codeArray</td><td>List</td><td>否</td><td>码号数组</td><td>所有的码同一个有效期，与codeObjArray选择一个上传。该值上传时codeValidEnd必填</td></tr><tr><td>codeValidEnd</td><td>String</td><td>否</td><td>码有效期结束时间</td><td>codeArray上传时，该值必填</td></tr><tr><td>codeObjArray</td><td>List&lt;CodeDelayInfo&gt;</td><td>是</td><td>码更新集</td><td>每个码单独对应一个有效期。与codeArray选择一个上传</td></tr><tr><td>saleChannelId</td><td>Long</td><td>否</td><td>取码方id</td><td> </td></tr><tr><td>saleChannelOrderId</td><td>String</td><td>否</td><td>取码方制码订单号</td><td>当codeArray和codeObjArray均无值时取该订单号下所有串码进行延期。当订单号有值时取码方id必填</td></tr><tr><td>callBackUrl</td><td>String</td><td>是</td><td>更新成功后的回调地址</td><td> </td></tr><tr><td>updateShopNo</td><td>String(10)</td><td>否</td><td>更新门店号</td><td> </td></tr><tr><td>updateOrg</td><td>String(10)</td><td>否</td><td>更行机构</td><td> </td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>B5：批量延期</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"20181019112535100000000000000001",
    "codeArray": ["10215523190570712621"],
    "callBackUrl": "http://test.com/api/codeVoid",
    "codeValidEnd": "20200224235959",
    "optTag": "B5",
}

```

**同步返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/598b3 "statusUpdateData")&gt;</td><td>是</td><td>批量码作废初步校验返回</td></tr></tbody></table>

**同步返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "requestId": "10000000000000000000002",
        "tradeNo": "10000000000000000000002",
        "codeNum": 1
    }
}

```

**回调返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-1"><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>data</td><td>Object&lt;[statusUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateCallbackData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**回调返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "totalCodeNum": 1,
        "successCodeNum": 1,
        "codeArray": [{
            "code": "100213321414112234",
            ...
            }],
    }
}
```

# 批量码作废

#### **接口用途**

- 多码批量作废时，调用此接口

#### **接口说明**

- 一次可以多码作废,一次最多20个码。

#### **action**

- `BatchCodeUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codeArray</td><td>List</td><td>是</td><td>码号数组</td><td> </td></tr><tr><td>saleChannelId</td><td>Long</td><td>否</td><td>取码方id</td><td> </td></tr><tr><td>saleChannelOrderId</td><td>String</td><td>否</td><td>取码方制码订单号</td><td>当codeArray无值时取该订单号下所有串码进行作废。当订单号有值时取码方id必填</td></tr><tr><td>callBackUrl</td><td>String</td><td>是</td><td>激活成功后的回调地址</td><td> </td></tr><tr><td>updateShopNo</td><td>String(10)</td><td>否</td><td>激活门店号</td><td> </td></tr><tr><td>updateOrg</td><td>String(10)</td><td>否</td><td>激活机构</td><td> </td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>B1：批量作废</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"20181019112535100000000000000001",
    "codeArray": ["10215523190570712621"],
    "callBackUrl": "http://test.com/api/codeVoid",
    "optTag": "B1",
}

```

**同步返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/598b3 "statusUpdateData")&gt;</td><td>是</td><td>批量码作废初步校验返回</td></tr></tbody></table>

**同步返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "requestId": "10000000000000000000002",
        "tradeNo": "10000000000000000000002",
        "codeNum": 1
    }
}

```

**回调返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-1" style="height: 122px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 87.0938px;">字段</th><th style="height: 29px; width: 238.734px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 143px;">字段意义</th><th style="height: 29px; width: 45px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 87.0938px;">returnCode</td><td style="height: 29px; width: 238.734px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 143px;">请求返回码</td><td style="height: 29px; width: 45px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 87.0938px;">returnMsg</td><td style="height: 29px; width: 238.734px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 143px;">请求返回信息</td><td style="height: 29px; width: 45px;"> </td></tr><tr style="height: 35px;"><td style="height: 35px; width: 87.0938px;">data</td><td style="height: 35px; width: 238.734px;">Object&lt;[statusUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/15438 "statusUpdateCallbackData")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 143px;">码状态更新返回数据</td></tr></tbody></table>

**回调返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "totalCodeNum": 1,
        "successCodeNum": 1,
        "codeArray": [{
            "codeId": "1212431432",
            "searchCode": "100***1234",
            "codeSecret": "100213321414112234",
            ...
            }],
    }
}
```

# 码信息更新接口

#### **接口用途**

- 当需要对指定码的部分信息进行更新时，调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。

#### **action**

- `CodeDetailUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-reques"><thead><tr><th>字段</th><th>类型</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td> </td></tr><tr><td>updateOpts</td><td>&lt;[updateOpt](https://book.e-buy.com/books/e-buy-40/page/02522 "updateOpt")&gt;</td><td>是</td><td>码明细更新操作</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20180912162026",
    "code": "1012123342335432145",
    "updateOpts": {
        "updatePurchaseTime": "20181103105501",
        "updateMakeNotifyType": {
            "mobilePhone": "13510121314"
        },
        "updateMerchantRealAmount": 1200
    }
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[statusUpdateData](https://book.e-buy.com/books/e-buy-40/page/01386 "statusUpdateData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20180912162026",
        "currentStatus": "00",
        "statusDesc":"未使用",
        "updateDate":"20181019",
        "updateTime":"20181019112535"
    }
}
```

# 码信息查询

#### **接口用途**

- 当需要查询某个指定码时，取码方调用此接口

#### **接口说明**

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。

#### **action**

- `CodeQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codes</td><td>List</td><td>是</td><td>验码集合</td><td>最大不超过20</td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>核销门店所属品牌</td><td>组合劵必须上送，易百提供</td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>门店所在城市id</td><td>易百提供的城市id</td></tr><tr><td>storeInfo</td><td>Object&lt;[storeInfo](https://book.e-buy.com/books/e-buy-40/page/54229 "storeInfo")&gt;</td><td>否</td><td>门店串码查询时上送</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20181019112535100000000000000002",
    "codes": ["1021242013780905000"],
    "brandId":"2429",
    "cityId":5493
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>data</td><td>Object&lt;[codeQueryResponseData](https://book.e-buy.com/books/e-buy-40/page/0584c "codeQueryResponseData")&gt;</td><td>否</td><td>码信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "171698602301",
    "data":{
        "codeDetail":[{
            "code":"1021242013780905000",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "saleChannelCode":"990001",
            "useTimes":1,
            "verifyTimes":1
            "remainTimes":0,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        },{
            "code":"1021242013780905001",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "remainTimes":1,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        }]
    }
}

```

#### **券状态枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01" style="width: 76.5432%; height: 560.8px;"><thead><tr style="height: 46.6px;"><th style="width: 7.26994%; height: 46.6px;">字段</th><th style="width: 44.7505%; height: 46.6px;">字段意义</th><th style="width: 47.9816%; height: 46.6px;">备注</th></tr></thead><tbody><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">00</td><td style="width: 44.7505%; height: 29.8px;">可使用</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">01</td><td style="width: 44.7505%; height: 29.8px;">已使用</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 46.6px;"><td style="width: 7.26994%; height: 46.6px;">02</td><td style="width: 44.7505%; height: 46.6px;">可使用(一码多次使用时，码还有可用次数)</td><td style="width: 47.9816%; height: 46.6px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">03</td><td style="width: 44.7505%; height: 29.8px;">未激活</td><td style="width: 47.9816%; height: 29.8px;">未激活的码需调用激活接口才能</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">04</td><td style="width: 44.7505%; height: 29.8px;">已冻结</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">05</td><td style="width: 44.7505%; height: 29.8px;">已作废</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">06</td><td style="width: 44.7505%; height: 29.8px;">已过期</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 46.6px;"><td style="width: 7.26994%; height: 46.6px;">07</td><td style="width: 44.7505%; height: 46.6px;">未生效</td><td style="width: 47.9816%; height: 46.6px;">当制码时选择次日生效，核销时会返回该状态</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">08</td><td style="width: 44.7505%; height: 29.8px;">不能退款</td><td style="width: 47.9816%; height: 29.8px;">仅核销场景-不支持核销撤销(根据业务场景配置是否支持隔日和当日核销撤销)</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">09</td><td style="width: 44.7505%; height: 29.8px;">券不存在</td><td style="width: 47.9816%; height: 29.8px;">券码不存在(券码查询、核销、核销撤销)</td></tr><tr><td style="width: 7.26994%; height: 29.8px;">21</td><td style="width: 44.7505%; height: 29.8px;">电子凭证不可用</td><td style="width: 47.9816%; height: 29.8px;">券码不在有效期

</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">35</td><td style="width: 44.7505%; height: 29.8px;">码配置异常</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">51</td><td style="width: 44.7505%; height: 29.8px;">改码不存在制码方</td><td style="width: 47.9816%; height: 29.8px;">  
</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">97</td><td style="width: 44.7505%; height: 29.8px;">报文错误</td><td style="width: 47.9816%; height: 29.8px;">接口调用参数校验不通过</td></tr><tr style="height: 29.8px;"><td style="width: 7.26994%; height: 29.8px;">C2</td><td style="width: 44.7505%; height: 29.8px;">商户无权限</td><td style="width: 47.9816%; height: 29.8px;">券码查询和核销 权限校验不通过</td></tr></tbody></table>

# 单码核销

#### **接口用途**

- 券码进行核销时，调用此接口

#### **接口说明**

- 一次只能对一个码进行核销。

#### **action**

- `CodeVerify`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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-v"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>verifyScene</td><td>String</td><td>是</td><td>交易场景.offline线下,online线上</td><td> </td></tr><tr><td>code</td><td>String</td><td>是</td><td>码号</td><td> </td></tr><tr><td>isProductCheck</td><td>String</td><td>是</td><td>是否校验订单产品规则</td><td>是Y，否N</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号确保永久唯一性</td><td>32位长度</td></tr><tr><td>refNo</td><td>String</td><td>否</td><td>系统参考号</td><td>12位长度</td></tr><tr><td>cashierTransNo</td><td>String</td><td>否</td><td>收银机流水号</td><td>最长64位长度</td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号确保永久唯一性</td><td>32位长度</td></tr><tr><td>storeInfo</td><td>Object&lt;[storeInfo](https://book.e-buy.com/books/e-buy-40/page/6f492 "storeInfo")&gt;</td><td>否</td><td>门店核销时上送，组合劵必填</td><td> </td></tr><tr><td>cashTotalAmount</td><td>Number</td><td>否</td><td>订单总金额（收银机总金额也是用此字段）</td><td>单位：分</td></tr><tr><td>goodsDetail</td><td>List&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/1d7f7-Fbe "goodsDetail")&gt;</td><td>否</td><td>(只有在收银POS上发起交易时才上送)</td><td> </td></tr><tr><td>remark</td><td>String</td><td>否</td><td>备注（在核销撤销、核销查询等接口原样返回）</td><td> </td></tr></tbody></table>

**请求报文举例**

```
{
    "verifyScene":"offline",
    "code": "10215523190570712621",
    "requestId": "20181019112535100000000000000001",
    "refNo": "181215430700",
    "cashierTransNo": "42441908138100007498001",
    "storeInfo": {
        "cityId":"1012",
        "swift": "00105",
        "tid": "99000014",
        "mid": "99000013341001",
        "shopNo": "C00001",
        "storeName": "上海浦东测试门店",
        "manageCompany": "上海浦东测试店管理公司",
        "companyId": "218"
    },
    "cashTotalAmount": "20000",
    "goodsDetail": [{
        "sku": "1112343",
        "qty": 1,
        "price": 3000,
        "type": "03",
        "spec": "03"
    }, {
        "sku": "1212342",
        "qty": 1,
        "price": 3500,
        "type": "03",
        "spec": "03"
    }]
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>返回码32时，请调用单码核销查询接口CodeVerifyQuery，确认核销结果</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>data</td><td>Object&lt;[data](https://book.e-buy.com/books/e-buy-40/page/f7490 "data")&gt;</td><td>是</td><td>券码核销订单明细返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000002",
    "data": {
        "cashTotalAmount": 17800,
        "faceValue": 50000,
        "fundsChannel": {
            "totalAmount": 50000,
            "discountAmount": 50000,
            "merchantRealAmount": 40000,
            "channelBenefit": 10000,
            "merchantBenefit": 10000,
            "userRealAmount": 30000
        },
        "goodsDetail": [{
            "sku": "1212342",
            "qty": 1,
            "price": 3500,
            "type": "03",
            "spec": "03"
        }],
        "code": "10215523190570712621",
        "ticketId": "3",
        "ticketName": "50 元现金抵价券 ",
        "activityNo": "2017071951",
        "activityName": "联动优势电子凭证",
        "thirdActivityId": "20190226134100",
        "returnCashParam":{
            "tenderCode":"132"
        },
        "printData": "00|产品：测试券|00|团购价：100|00|订单号：100000000002100002|00|兑换码：101105********4289|"
    }
}
```

# 单码核销撤销

#### **接口用途**

- 当需要将本次核销交易撤销时调用

#### **接口说明**

- 此接口支持撤销指定日期的核销交易

#### **action**

- `CodeVerifyVoid`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>小于32个字符</td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>原核销请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000001",
    "originalRequestId":"10000000000000000000002"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>requestId</td><td>String</td><td>是</td><td>原样返回</td><td> </td></tr><tr><td>amount</td><td>Number</td><td>否</td><td>本次撤销金额单位分</td><td>仅在收银一体化时用到</td></tr><tr><td>code</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>verifyRemark</td><td>String</td><td>否</td><td>核销备注信息</td><td>核销接口上送原样返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": 10000000000000000000001,
    "amount": "5000",
    "code": "10215523190570712621",
    "ticketName": "50 元现金抵价券 "
}
```

# 单码核销查询

#### **接口用途**

- 核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果

#### **接口说明**

- 此接口默认支持查询当日内核销交易
- 也可传参originalDate查询指定日核销交易

#### **action**

- `CodeVerifyQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>原核销请求流水号</td><td>32个字符</td></tr><tr><td>originalDate</td><td>String</td><td>否</td><td>原交易日期</td><td>传入需要查询的原交易日期，不传默认为当天格式为yyyyMMdd</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20180905000",
    "originalRequestId":"1021867639235435",
    "originalDate": "20170912"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0" 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;">returnCode</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;">returnMsg</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;">requestId</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;">verifyRemark</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;">data</td><td style="width: 121px;">Object&lt;[data](https://book.e-buy.com/books/e-buy-40/page/f7490 "data")&gt;</td><td style="width: 42px;">是</td><td style="width: 164px;">券码核销订单明细返回</td><td style="width: 351px;"> </td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000002",
    "data": {
        "cashTotalAmount": 17800,
        "fundsChannel": {
            "totalAmount": 50000,
            "discountAmount": 50000,
            "merchantRealAmount": 40000,
            "channelBenefit": 10000,
            "merchantBenefit": 10000,
            "userRealAmount": 30000
        },
        "goodsDetail": [{
            "sku": "1212342",
            "qty": 1,
            "price": 3500,
            "type": "03",
            "spec": "03"
        }],
        "code": "10215523190570712621",
        "ticketId": "3",
        "ticketName": "50 元现金抵价券 ",
        "activityNo": "2017071951",
        "activityName": "联动优势电子凭证",
        "printData": "00|产品：测试券|00|团购价：100|00|订单号：100000000002100002|00|兑换码：101105********4289|"
    }
}
```

# 单码核销通知

#### **接口用途**

- 用于实现易百券核销成功后将核销状态通知到第三方系统

#### **接口说明**

- 接口异步通知第三方

**请求参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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" style="width: 86.9136%; height: 476.75px;"><thead><tr style="height: 29.7969px;"><th style="width: 17.0055%; height: 29.7969px;">字段</th><th style="width: 7.5506%; height: 29.7969px;">类型</th><th style="width: 10.3693%; height: 29.7969px;">是否必填</th><th style="width: 32.2443%; height: 29.7969px;">字段意义</th><th style="width: 32.6372%; height: 29.7969px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">requestId</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">核销流水号</td><td style="width: 32.6372%; height: 29.7969px;">小于64个字符</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">channelId</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">通知渠道</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">ticketId</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">券ID</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">ticketName</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">券名称</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">thirdActivityId</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">第三方活动id</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">code</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">券号</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">shopNo</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">否</td><td style="width: 32.2443%; height: 29.7969px;">门店编号</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">shopName</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">否</td><td style="width: 32.2443%; height: 29.7969px;">门店名称</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">verifyRefno</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">否</td><td style="width: 32.2443%; height: 29.7969px;">线下核销机具流水号</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">verifyTime</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">券核销时间</td><td style="width: 32.6372%; height: 29.7969px;">格式：yyyyMMddHHmmss</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">verifyType</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">核销类型</td><td style="width: 32.6372%; height: 29.7969px;">1表示POS机验证； 2表示接口验证；

999 表示不用通知上下游

</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">orderNo</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">制码订单号</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">orderItemId</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">是</td><td style="width: 32.2443%; height: 29.7969px;">制码子订单号，对接方唯一识别码</td><td style="width: 32.6372%; height: 29.7969px;">  
</td></tr><tr style="height: 29.7969px;"><td style="width: 17.0055%; height: 29.7969px;">discountAmount</td><td style="width: 7.5506%; height: 29.7969px;">String</td><td style="width: 10.3693%; height: 29.7969px;">否</td><td style="width: 32.2443%; height: 29.7969px;">核销折抵金额</td><td style="width: 32.6372%; height: 29.7969px;">单位分</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000001",
    "ticketId":"9000000021",
    "ticketName":"汉堡王皇堡/天椒皇堡套餐[bobo测试取码方]",
    "thirdActivityId": "20190226134100",
    "code":"10112504119074937195",
    "shopNo":"1870002",
    "shopName":"家有好面龙阳路店",
    "verifyRefno":"178491000582",
    "verifyTime":"20181016103223",
    "verifyType":"1",
    "orderNo":"a1b626f8b39b4852bfaedc69cc4dbff5",
    "orderItemId":"10191f7aee084db8915dd77293a65906",
    "discountAmount":"2000"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>09 券码不存在

01 券码已使用

00 券码核销成功

</td></tr><tr><td>returnMsg</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>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000001"
}
```

# 单码核销撤销通知

#### **接口用途**

- 用于实现易百券核销撤销成功后将通知到第三方系统

#### **接口说明**

- 接口异步通知第三方

**请求参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")&lt;===&gt;CHANNEL**

<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>requestId</td><td>String</td><td>是</td><td>核销撤销请求流水号</td><td>小于64个字符</td></tr><tr><td>verifyTime</td><td>String</td><td>是</td><td>券核销撤销时间</td><td>格式：yyyyMMddHHmmss</td></tr><tr><td>code</td><td>String</td><td>是</td><td>劵码</td><td> </td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>原核销交易流水号</td><td>小于64个字符</td></tr><tr><td>orderNo</td><td>String</td><td>否</td><td>制码订单号</td><td> </td></tr><tr><td>orderItemId</td><td>String</td><td>否</td><td>制码子订单号，对接方唯一识别码</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000002",
    "verifyTime":"20181016103223",
    "code":"10215523190570712621",
    "originalRequestId": "10000000000000000001001",
    "orderNo":"a1b626f8b39b4852bfaedc69cc4dbff5",
    "orderItemId":"10191f7aee084db8915dd77293a65906"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>requestId</td><td>String</td><td>是</td><td>原样返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000001"
}
```

# 码预核销接口

#### **接口用途**

- 当需要确认码是否可用在当前场景时，调用此接口，

#### **接口说明**

- 建议单码场景使用。多码需确认是否满足需求。

#### **action**

- `CodeCheck`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codes</td><td>List</td><td>是</td><td>验码集合</td><td> </td></tr><tr><td>cashTotalAmount</td><td>Number</td><td>是</td><td>订单金额</td><td>单位：分</td></tr><tr><td>isProductCheck</td><td>String</td><td>是</td><td>是否校验订单产品规则</td><td>是Y，否N</td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>品牌id</td><td>多品牌使用的码，此字段必传</td></tr><tr><td>shopNo</td><td>String(20)</td><td>否</td><td>门店号</td><td>线下场景必填</td></tr><tr><td>tid</td><td>String(8)</td><td>否</td><td>终端号</td><td> </td></tr><tr><td>cityId</td><td>String</td><td>否</td><td>城市id，对接时使用ebuy城市id</td><td>有规则时必须上传</td></tr><tr><td>goodsDetail</td><td>Object&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/1d7f7-Fbe "goodsDetail")&gt;</td><td>否</td><td>折抵产品明细</td><td>目前支持单码预核销检查使用</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"2018111911253510000010",
    "codes":["101111111111","1022222222222","1033333333333","104444444444"],
    "cashTotalAmount":"20000",
    "brandId":"121",
    "tid":"99000014",
    "shopNo":"123456",
    "cityId":"1012",
    "companyId":"11",
    "goodsDetail":[{
        "sku": "1112343",
        "qty": 1,
        "price": 3000,
        "type": "03",
        "spec": "03"
            }, {
        "sku": "1212342",
        "qty": 1,
        "price": 3500,
        "type": "03",
        "spec": "03"
        }]
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>00为成功，其他均为失败</td><td> </td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>data/checkResult</td><td>Object&lt;[data/checkResult](https://book.e-buy.com/books/e-buy-40/page/e1e32 "checkResult")&gt;</td><td>是</td><td>劵码查询结果</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "checkResult":[{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "00",
            "discountAmount":3000
        },{
            "code":"1021242013780905000",
            "saleChannelCode":"990001",
            "saleChannelName":"易百码",
            "status": "06",
            "discountAmount":3000,
        }]
    }
}

```

#### **券状态枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E7%94%A8-01-"><thead><tr><th>字段</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>00</td><td>可用</td></tr><tr><td>01</td><td>已使用</td></tr><tr><td>03</td><td>未激活</td><td>未激活的码需调用激活接口才能</td></tr><tr><td>04</td><td>已冻结</td></tr><tr><td>05</td><td>已作废</td></tr><tr><td>06</td><td>已过期</td><td> </td></tr><tr><td>07</td><td>未生效</td><td>当制码时选择次日生效，核销时会返回该状态</td></tr><tr><td>09</td><td>码不存在</td></tr><tr><td>35</td><td>劵数据异常</td><td>联系易百确认</td></tr><tr><td>39</td><td>核销失败</td></tr><tr><td>91</td><td>核销异常</td></tr></tbody></table>

# 批量码核销

#### **接口用途**

- 多码批量核销时，调用此接口

#### **接口说明**

- 一次可以多码核销,一次最多10个码。

#### **action**

- `BatchCodesVerify`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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-v" style="height: 302px; width: 690px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 173px;">字段</th><th style="height: 29px; width: 89px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 251px;">字段意义</th><th style="height: 29px; width: 104px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 173px;">verifyScene</td><td style="height: 29px; width: 89px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 251px;">交易场景.offline线下,online线上</td><td style="height: 29px; width: 104px;">线上也可以传抖音、美团等</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">codes</td><td style="height: 29px; width: 89px;">List</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 251px;">码号数组</td><td style="height: 29px; width: 104px;"> </td></tr><tr><td style="width: 173px;">verifyCodes</td><td style="width: 89px;">List&lt;[codeArr](https://book.e-buy.com/books/e-buy-40/page/cfa08)&gt;</td><td style="width: 73px;">否</td><td style="width: 251px;">指定券码阶梯价序号</td><td style="width: 104px;">  
</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">isProductCheck</td><td style="height: 29px; width: 89px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 251px;">是否校验订单产品规则</td><td style="height: 29px; width: 104px;">是Y，否N</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">requestId</td><td style="height: 29px; width: 89px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 251px;">请求流水号确保永久唯一性</td><td style="height: 29px; width: 104px;">32位长度</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">refNo</td><td style="height: 29px; width: 89px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 251px;">系统参考号</td><td style="height: 29px; width: 104px;">12位长度</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">cashierTransNo</td><td style="height: 29px; width: 89px;">String</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 251px;">收银机流水号</td><td style="height: 29px; width: 104px;">最长64位长度</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 173px;">storeInfo</td><td style="height: 35px; width: 89px;">Object&lt;[storeInfo](https://book.e-buy.com/books/e-buy-40/page/6f492 "storeInfo")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 251px;">此信息为线下门店核销时上送</td><td style="height: 35px; width: 104px;">线下核销必填</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 173px;">cashTotalAmount</td><td style="height: 29px; width: 89px;">Number</td><td style="height: 29px; width: 73px;">否</td><td style="height: 29px; width: 251px;">订单总金额</td><td style="height: 29px; width: 104px;">单位：分</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 173px;">goodsDetail</td><td style="height: 35px; width: 89px;">List&lt;[goodsDetail](https://book.e-buy.com/books/e-buy-40/page/1d7f7-Fbe "goodsDetail")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 251px;">(只有在收银POS上发起交易时才上送)</td><td style="width: 104px;"> </td></tr><tr><td style="width: 173px;">remark</td><td style="width: 89px;">String</td><td style="width: 73px;">否</td><td style="width: 251px;">备注（在核销撤销、核销查询等接口原样返回）</td><td style="width: 104px;"> </td></tr></tbody></table>

**请求报文举例**

```
{
    "verifyScene":"online",
    "codes": ["10215523190570712621"],
    "requestId": "20181019112535100000000000000001",
    "refNo": "181215430700",
    "cashierTransNo": "42441908138100007498001",
    "storeInfo": {
        "cityId":"1012",
        "shopNo": "C00001",
        "shopName": "上海浦东测试门店",
        "manageCompany": "上海浦东测试店管理公司",
        "companyId": "218"
    },
    "cashTotalAmount": "20000",
    "goodsDetail": [{
        "sku": "1112343",
        "qty": 1,
        "price": 3000,
        "type": "03",
        "spec": "03"
    }, {
        "sku": "1212342",
        "qty": 1,
        "price": 3500,
        "type": "03",
        "spec": "03"
    }]
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>返回码32时，请调用单码核销查询接口CodeVerifyQuery，确认核销结果</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>data/checkResult</td><td>Object&lt;[data/checkResult](https://book.e-buy.com/books/e-buy-40/page/1afa3 "data")&gt;</td><td>是</td><td>券码核销信息明细返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "requestId": "10000000000000000000002",
    "returnCode": "00",
    "returnMsg": "操作成功",
    "data": {
        "verifyResult":[{
              "code":"1021242013780905000",
              "saleChannelCode":"990001",
              "saleChannelCode":"易百码",
              "status":"00",
              "fundsChannel": {
                      "discountAmount": 3000,
                      "merchantRealAmount":0.0,
                      "channelBenefit": 0.0,
                      "merchantBenefit": 0.0
              },
              "faceValue":3000,
              "ticketId":"3",
              "ticketName":"30元现金抵价券",
              "returnCashParam":{
                    "tenderCode":"135"
              }
        },{
              "code":"1021242013780905000",
              "saleChannelCode":"990001",
              "saleChannelCode":"易百码",
              "status":"06",
              "fundsChannel": {
                    "discountAmount": 1000,
                    "merchantRealAmount":0.0,
                    "channelBenefit": 0.0,
                    "merchantBenefit": 0.0
              },
              "faceValue":1000,
              "ticketId":"6",
              "ticketName":"10元现金抵价券",
              "returnCashParam":{
                    "tenderCode":"132"
              }
        }]
    }
}

```

#### **status枚举**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01"><thead><tr><th>字段</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>00</td><td>可使用</td></tr><tr><td>01</td><td>已使用</td></tr><tr><td>03</td><td>未激活</td><td>未激活的码需调用激活接口才能</td></tr><tr><td>04</td><td>已冻结</td></tr><tr><td>05</td><td>已作废</td></tr><tr><td>06</td><td>已过期</td><td> </td></tr><tr><td>07</td><td>未生效</td><td>当制码时选择次日生效，核销时会返回该状态</td></tr><tr><td>09</td><td>码不存在</td></tr><tr><td>10</td><td>券码状态异常，券码无效</td></tr><tr><td>23</td><td>商户商品号传送错误</td></tr><tr><td>26</td><td>券码不能在本门店使用</td></tr><tr><td>C1</td><td>商户号门店信息有误</td></tr><tr><td>C2</td><td>商户无权限</td></tr><tr><td>T2</td><td>易百调用第三方失败</td></tr><tr><td>A4</td><td>其他异常</td></tr></tbody></table>

# 批量码核销查询

#### **接口用途**

- 批量核销接口调用超时对核销结果未知道，可以调用此接口来查询核销结果

#### **接口说明**

- 此接口默认支持查询当日内核销交易
- 也可传参originalDate查询指定日核销交易

#### **action**

- `BatchCodeVerifyQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>原核销请求流水号</td><td>32个字符</td></tr><tr><td>originalDate</td><td>String</td><td>否</td><td>原交易日期</td><td>传入需要查询的原交易日期，不传默认为当天格式为yyyyMMdd</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20180905000",
    "originalRequestId":"1021867639235435",
    "originalDate": "20170912"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0" 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;">returnCode</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;">returnMsg</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;">requestId</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;">verifyRemark</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;">data/verifyQueryResponse</td><td style="width: 121px;">Object&lt;[data/verifyQueryResponse](https://book.e-buy.com/books/e-buy-40/page/19f3c-LQF "data")&gt;</td><td style="width: 42px;">是</td><td style="width: 164px;">券码核销订单明细返回</td><td style="width: 351px;"> </td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000002",
    "data": {
        "verifyQueryResponse": [{
            "cashTotalAmount": 17800,
            "fundsChannel": {
                "totalAmount": 50000,
                "discountAmount": 50000,
                "merchantRealAmount": 40000,
                "channelBenefit": 10000,
                "merchantBenefit": 10000,
                "userRealAmount": 30000
            },
            "goodsDetail": [{
                "sku": "1212342",
                "qty": 1,
                "price": 3500,
                "type": "03",
                "spec": "03"
            }],
            "code": "10215523190570712621",
            "ticketId": "3",
            "ticketName": "50 元现金抵价券 ",
            "activityNo": "2017071951",
            "activityName": "联动优势电子凭证",
            "printData": "00|产品：测试券|00|团购价：100|00|订单号：100000000002100002|00|兑换码：101105********4289|"
        }]
    }
}
```

# 批量码核销撤销

#### **接口用途**

- 多码批量核销订单撤销时或订单中部分码撤销，调用此接口。

#### **接口说明**

- 撤销批量核销订单，调用前请确认订单是否符合撤销条件。

#### **action**

- `BatchCodeVerifyVoid`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>小于32个字符</td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>原核销请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codes</td><td>List</td><td>否</td><td>原订单中批量核销撤销的码</td><td>此字段不填默认整订单撤销</td></tr><tr><td>voidDate</td><td>String</td><td>否</td><td>原交易时间,默认当天</td><td>格式:YYYYMMDD</td></tr><tr><td>isAtomicity</td><td>String</td><td>否</td><td>是否需要支持原子性，原交易中码核销撤销要么全部成功要么全部失败</td><td>Y：是，N：否（默认）</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000001",
    "originalRequestId":"10000000000000000000002"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0" 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;">returnCode</td><td style="width: 121px;">String</td><td style="width: 42px;">是</td><td style="width: 164px;">请求返回码</td><td style="width: 351px;">返回码32时，请调用单码核销查询接口CodeVerifyQuery，确认核销结果</td></tr><tr><td style="width: 131px;">returnMsg</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;">verifyRemark</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;">data/voidResult</td><td style="width: 121px;">Object&lt;[data/voidResult](https://book.e-buy.com/books/e-buy-40/page/18997)&gt;</td><td style="width: 42px;">是</td><td style="width: 164px;">券码核销信息明细返回</td><td style="width: 351px;"> </td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": 10000000000000000000002,
    "data": {
        "voidResult":[{
              "code":"1021242013780905000",
              "status":"00",
              "statusDesc":"成功",
              "amount": "5000",
              "ticketName": "50 元现金抵价券 "
        }]
    }
}
```

# 取码方可用券查询

#### **接口用途**

- 当取码方需要知道自己可用的券时，可调用此接口

#### **action**

- `ChannelTicketQuery`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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-a"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "20181019112535100000000000000002",
    "activityValidStart": "20180901000000",
    "activityValidEnd": "20181231595959"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>List&lt;[channelTicketQuery](https://book.e-buy.com/books/e-buy-40/page/f7664 "channelTicketQuery")&gt;</td><td>否</td><td>券信息</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": [{
        "ticketId": "10001",
        "ticketName": "星巴克30元代金券",
        "activityId": "20001",
        "activityName": "浦发星巴克代金券活动",
        "activityValidStart": "20180901000000",
        "activityValidEnd": "20181231595959",
        "thirdActivityId": "20190226134100",
        "codeValidStart": "20180901000000",
        "codeValidEnd": "20181231595959",
        "createDate": "20181018",
        "createTime": "20181018183454",
        "activityUseDescription": {
            "useDescription":活动使用说明""
        },
        "ticketUseDescription": {
            "ticketPicture":"www.baidu.com",
            "useThreshold":"使用门槛",
            "discountDescription":"优惠说明",
            "useDescription":"使用说明"
        }
    },{
        "ticketId": "10002",
        "ticketName": "星巴克50元代金券",
        "activityId": "20001",
        "activityName": "浦发星巴克代金券活动",
        "activityValidStart": "20180901000000",
        "activityValidEnd": "20181231595959",
        "codeValidStart": "20180901000000",
        "codeValidEnd": "20181231595959",
        "createDate": "20181018",
        "createTime": "20181018183454",
        "activityUseDescription": {
            "useDescription":活动使用说明""
        },
        "ticketUseDescription": {
            "ticketPicture":"www.baidu.com",
            "useThreshold":"使用门槛",
            "discountDescription":"优惠说明",
            "useDescription":"使用说明"
        }
    }]
}
```

# 外部核销通知

#### **接口用途**

- 用于实现外部系统劵成功后通知到易百

#### **接口说明**

- 第三方通知EBUY

#### **action**

- `CodeVerifyNotify`

**请求参数，CHANNEL**===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>小于32个字符</td></tr><tr><td>thirdVerifyId</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>brandId</td><td>String</td><td>是</td><td>品牌</td><td>易百定义</td></tr><tr><td>code</td><td>String</td><td>是</td><td>券号</td><td> </td></tr><tr><td>mid</td><td>String</td><td>否</td><td>商户号</td><td> </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>tid</td><td>String</td><td>否</td><td>pos终端号</td><td> </td></tr><tr><td>verifyTime</td><td>String</td><td>是</td><td>券核销时间</td><td>格式：yyyyMMddHHmmss</td></tr><tr><td>verifyType</td><td>String</td><td>是</td><td>核销类型</td><td>1表示POS机验证；2表示接口验证</td></tr><tr><td>orderNo</td><td>String</td><td>否</td><td>制码订单号</td><td> </td></tr><tr><td>orderItemId</td><td>String</td><td>否</td><td>制码子订单号，对接方唯一识别码</td><td> </td></tr><tr><td>amount</td><td>Number</td><td>否</td><td>核销金额</td><td>单位：分</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000002",
    "originalRequestId":"10000000000000000000001",
    "ticketName":"汉堡王皇堡/天椒皇堡套餐",
    "code":"10112504119074937195",
    "shopNo":"1870002",
    "shopName":"家有好面龙阳路店",
    "verifyTime":"20181016103223",
    "verifyType":"1",
    "orderNo":"a1b626f8b39b4852bfaedc69cc4dbff5",
    "orderItemId":"10191f7aee084db8915dd77293a65906"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>requestId</td><td>String</td><td>是</td><td>原样返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000002"
}
```

# 外部核销撤销通知

#### **接口用途**

- 用于实现第三方核销撤销EBUY的劵成功后通知[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")

#### **接口说明**

- 第三方核销撤销成功后通知EBUY

#### **action**

- `CodeVerifyVoidNotify`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>核销撤销请求流水号</td><td>小于64个字符</td></tr><tr><td>originalRequestId</td><td>String</td><td>是</td><td>第三方核销时流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>voidTime</td><td>String</td><td>是</td><td>券撤销时间</td><td>格式：yyyyMMddHHmmss</td></tr><tr><td>code</td><td>String</td><td>是</td><td>劵码</td><td> </td></tr><tr><td>orderNo</td><td>String</td><td>否</td><td>制码订单号</td><td> </td></tr><tr><td>orderItemId</td><td>String</td><td>否</td><td>制码子订单号，对接方唯一识别码</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId": "10000000000000000000002",
    "originalRequestId":"10000000000000000000001",
    "voidTime":"20181016103223",
    "code":"10215523190570712621",
    "orderNo":"a1b626f8b39b4852bfaedc69cc4dbff5",
    "orderItemId":"10191f7aee084db8915dd77293a65906"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-0"><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>requestId</td><td>String</td><td>是</td><td>原样返回</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "10000000000000000000001"
}
```

# 串码通知到用户微信卡包接口

#### **接口用途**

- 当需要将已制出的串码通知到用户微信卡包时，调用此接口

#### **接口说明**

- 易百不提供插入微信卡包功能，插入卡包的服务商为该码的制码方。
- 此接口为异步执行，同步返回成功表明任务提交成功，实际插入卡包结果异步通知到。

#### **action**

- `NotifyCodeToUser`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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: 122px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 166.641px;">字段</th><th style="height: 29px; width: 226.516px;">类型</th><th style="height: 29px; width: 73px;">是否必填</th><th style="height: 29px; width: 101px;">字段意义</th><th style="height: 29px; width: 45px;">备注</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 166.641px;">code</td><td style="height: 29px; width: 226.516px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 101px;">待通知串码号</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 166.641px;">callBackUrl</td><td style="height: 29px; width: 226.516px;">String</td><td style="height: 29px; width: 73px;">是</td><td style="height: 29px; width: 101px;">结果回调地址</td><td style="height: 29px; width: 45px;"> </td></tr><tr style="height: 35px;"><td style="height: 35px; width: 166.641px;">weChatCardPackageInfo</td><td style="height: 35px; width: 226.516px;">Object&lt;[weChatCardPackageInfo](https://book.e-buy.com/books/e-buy-40/page/ad972-VKK "weChatCardPackageInfo")&gt;</td><td style="height: 35px; width: 73px;">否</td><td style="height: 35px; width: 101px;">微信卡包信息</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"20181018183139",
    "code": "100243020180912162026",
    "callBackUrl": "www.XXX.com",
    "weChatCardPackageInfo":{
        "userUnionId":"1rbu123430vj"
    }
}

```

**同步返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>data</td><td>Object&lt;[notifyCodeToCardPackageResponse](https://book.e-buy.com/books/e-buy-40/page/d947b "notifyCodeToCardPackageResponse")&gt;</td><td>否</td><td>同步返回报文</td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181018183139",
    }
}

```

**异步返回参数，ESB===&gt;CHANNEL**

- 默认情况下异步报文与同步报文一致

# 星巴克箱包本码查询

#### **接口用途**

- 当需查询箱包本码集合

#### **接口说明**

- 传入箱、本、码编号，分别获得对应的码列表

####  

**请求参数**

<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>queryType</td><td>String</td><td>是</td><td>查询类型</td><td>X 箱， B1 包， B2本</td></tr><tr><td>queryCode</td><td>String</td><td>是</td><td>查询编号</td><td> </td></tr></tbody></table>

**请求报文举例**

```
{
    "queryType": "X",
    "queryCode":"123"
}

```

**返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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>00 正常，非00是错误</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>请求返回信息</td><td> </td></tr><tr><td>codeList</td><td>List&lt;String&gt;</td><td>否</td><td>码信息</td><td> </td></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": [
    	"100000000001212121",
        "100000000001212122",
        "100000000001212123"
    ]
}
```

# 异步第三方制码

#### **接口用途**

- 用于异步第三方制码的请求参数，发送到whale-gateway数据格式

#### **接口说明**

- 这里规定了标准的请求报文格式，发送到whale-gateway模块，然后具体对于不同码商的报文格式需要gateway转换

#### **action**

- **MakeCode**

**请求参数，whale===&gt;whale-gateway**

<table border="1" class="align-center" 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: 100%; border-collapse: collapse; border-style: double; height: 464px;"><tbody><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">字段</td><td style="width: 161.8px; height: 29px;">类型</td><td style="width: 161.8px; height: 29px;">是否必填</td><td style="width: 161.8px; height: 29px;">字段意义</td><td style="width: 161.8px; height: 29px;">备注</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">channelId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">渠道Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">channelTicketId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">渠道批次Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">codeValidEnd</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">券码有效期结束时间</td><td style="width: 161.8px; height: 29px;">格式为yyyyMMdd235959</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">codeValidStart</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">券码有效期开始时间</td><td style="width: 161.8px; height: 29px;">格式为yyyyMMdd000000</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">faceValue</td><td style="width: 161.8px; height: 29px;">Double</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">券面值</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">netValue</td><td style="width: 161.8px; height: 29px;">Double</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">净值</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">orderId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">订单Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">requestId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">请求流水号</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">saleChannelOrderId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">外部订单编号</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">totalCount</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">制码数量</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">transDate</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">交易日期</td><td style="width: 161.8px; height: 29px;">格式为

yyyyMMdd

</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">transTime</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">交易时间</td><td style="width: 161.8px; height: 29px;">格式为

yyyyMMddHHmmss

</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">useTimes</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">可核销次数</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">whaleTicketId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">whale券Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">saleChannelItemId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">子订单号</td><td style="width: 161.8px; height: 29px;"> </td></tr></tbody></table>

**请求报文举例**

```JSON
{
  "channelId": "136",
  "faceValue": -1,
  "makeFundsChannel": {
    "benefitAmount": 0,
    "channelBenefit": 0,
    "discountAmount": 0,
    "merchantBenefit": 0,
    "merchantCustomBenefit": -1,
    "merchantCustomRealAmount": -1,
    "merchantRealAmount": 10,
    "totalAmount": 100,
    "userRealAmount": 80
  },
  "netValue": -1,
  "orderId": "d84c1302a5e84774813bc9f1b7aaea8a",
  "orderRemark": "testtttt",
  "requestId": "d84c1302a5e84774813bc9f1b7aaea8a",
  "saleChannelOrderId": "d84c1302a5e84774813bc9f1b7aaea8a",
  "totalCount": "1",
  "transDate": "20220506",
  "transTime": "20220506215213",
  "useTimes": "12",
  "whaleTicketId": "162"
}
```

**返回参数，whale-gateway===&gt;whale**

<table border="1" 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" style="border-collapse: collapse; width: 100%; height: 145px;"><tbody><tr style="height: 29px;"><td style="width: 20%; height: 29px;">字段</td><td style="width: 20%; height: 29px;">类型</td><td style="width: 20%; height: 29px;">是否必填</td><td style="width: 20%; height: 29px;">字段意义</td><td style="width: 20%; height: 29px;">备注</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">returnCode</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">是</td><td style="width: 20%; height: 29px;">请求返回码</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">returnMsg</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">是</td><td style="width: 20%; height: 29px;">请求返回信息</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">sendChannelOrderId</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">否</td><td style="width: 20%; height: 29px;">订单号</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">thirdCodeFamilySet</td><td style="width: 20%; height: 29px;">List&lt;[CodeFamilyInfoBO](https://book.e-buy.com/books/e-buy-40/page/a5bfc)&gt;</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;"> </td></tr></tbody></table>

**返回报文举例**

```JSON
{
	"returnCode": "00",
    "returnMsg": "SUCCESS",
    "sendChannelOrderId": "",
    "thirdCodeFamilySet": []
}
```

# 第三方码异步结果通知

#### **接口用途**

- 第三方券码异步处理完成后的通知接口

#### **接口说明**

- 接收统一的报文格式

#### **action**

- `<strong>AsynThirdCodeCallback</strong>`

**请求参数，CHANNEL===&gt;WHALE**

<table border="1" 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="border-collapse: collapse; width: 100%; height: 226px;"><tbody><tr style="height: 29px;"><td style="width: 20%; height: 29px;">字段</td><td style="width: 20%; height: 29px;">类型</td><td style="width: 20%; height: 29px;">是否必填</td><td style="width: 20%; height: 29px;">字段意义</td><td style="width: 20%; height: 29px;">备注</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">createDate</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;">创建日期</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">createTime</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;">创建时间</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">returnCode</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;">返回编码</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">outerOrderId</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;">制码订单号</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 52px;"><td style="width: 20%; height: 52px;">codeFamilyInfo</td><td style="width: 20%; height: 52px;">[CodeFamilyInfoBO](https://book.e-buy.com/books/e-buy-40/page/a5bfc)</td><td style="width: 20%; height: 52px;"> </td><td style="width: 20%; height: 52px;">券码</td><td style="width: 20%; height: 52px;"> </td></tr></tbody></table>

# 同步批量码作废

#### **接口用途**

- 多码批量作废时，调用此接口

#### **接口说明**

- 一次可以多码作废,一次最多20个码。

#### **action**

- `SyncBatchCodeUpdate`

**请求参数，CHANNEL===&gt;[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")**

<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>requestId</td><td>String</td><td>是</td><td>请求流水号</td><td>32个字符，用于标识唯一一笔交易</td></tr><tr><td>codeArray</td><td>List</td><td>是</td><td>码号数组</td><td> </td></tr><tr><td>saleChannelId</td><td>Long</td><td>否</td><td>取码方id</td><td> </td></tr><tr><td>saleChannelOrderId</td><td>String</td><td>否</td><td>取码方制码订单号</td><td>当codeArray无值时取该订单号下所有串码进行作废。当订单号有值时取码方id必填</td></tr><tr><td>callBackUrl</td><td>String</td><td>是</td><td>激活成功后的回调地址</td><td> </td></tr><tr><td>updateShopNo</td><td>String(10)</td><td>否</td><td>激活门店号</td><td> </td></tr><tr><td>updateOrg</td><td>String(10)</td><td>否</td><td>激活机构</td><td> </td></tr><tr><td>optTag</td><td>String(2)</td><td>是</td><td>操作分类</td><td>B1：批量作废</td></tr></tbody></table>

**请求报文举例**

```
{
    "requestId":"20181019112535100000000000000001",
    "codeArray": ["10215523190570712621"],
    "callBackUrl": "http://test.com/api/codeVoid",
    "optTag": "B1",
}

```

**同步返回参数，[WHALE](https://book.e-buy.com/books/e-buy-40/page/7f100 "易百电子凭证4.0系统的别称")===&gt;CHANNEL**

<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-1" style="font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px;"><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>data</td><td>Object&lt;[statusUpdateCallbackData](https://book.e-buy.com/books/e-buy-40/page/15438 "statusUpdateCallbackData")&gt;</td><td>否</td><td>码状态更新返回数据</td></tr></tbody></table>

**回调返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS",
    "data": {
        "tradeNo": "9e22d9a9e532435db77bccdfd8a74ee5",
        "requestId": "20181019112535100000000000000008",
        "totalCodeNum": 1,
        "successCodeNum": 1,
        "codeArray": [{
            "codeId": "1212431432",
            "searchCode": "100***1234",
            "codeSecret": "100213321414112234",
            ...
            }],
    }
}
```

# 异步第三方作废接口

#### **接口用途**

- 用于异步第三方制码的请求参数，发送到whale-gateway数据格式

#### **接口说明**

- 这里规定了标准的请求报文格式，接收ebuyweb-gateway请求

#### **action**

- **syncUpdateCodeStatus**

**请求参数，whale===&gt;whale-gateway**

<table border="1" class="align-center" 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: 100%; border-collapse: collapse; border-style: double; height: 464px;"><tbody><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">字段</td><td style="width: 161.8px; height: 29px;">类型</td><td style="width: 161.8px; height: 29px;">是否必填</td><td style="width: 161.8px; height: 29px;">字段意义</td><td style="width: 161.8px; height: 29px;">备注</td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">outerOrderId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">渠道Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 161.8px; height: 29px;">channelTicketId</td><td style="width: 161.8px; height: 29px;">String</td><td style="width: 161.8px; height: 29px;">是</td><td style="width: 161.8px; height: 29px;">渠道批次Id</td><td style="width: 161.8px; height: 29px;"> </td></tr><tr><td style="width: 161.8px;">reason</td><td style="width: 161.8px;">String</td><td style="width: 161.8px;">否</td><td style="width: 161.8px;">退款原因</td><td style="width: 161.8px;"> </td></tr></tbody></table>

**请求报文举例**

```JSON
{
  "outerOrderId": "03136aaaaaaaaaaa",
  "channelTicketId": "162",
  "reason": "reason"
}
```

**返回参数，whale-gateway===&gt;whale**

<table border="1" 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" style="border-collapse: collapse; width: 100%; height: 145px;"><tbody><tr style="height: 29px;"><td style="width: 20%; height: 29px;">字段</td><td style="width: 20%; height: 29px;">类型</td><td style="width: 20%; height: 29px;">是否必填</td><td style="width: 20%; height: 29px;">字段意义</td><td style="width: 20%; height: 29px;">备注</td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">returnCode</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">是</td><td style="width: 20%; height: 29px;">请求返回码</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">returnMsg</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">是</td><td style="width: 20%; height: 29px;">请求返回信息</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">sendChannelOrderId</td><td style="width: 20%; height: 29px;">String</td><td style="width: 20%; height: 29px;">否</td><td style="width: 20%; height: 29px;">订单号</td><td style="width: 20%; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="width: 20%; height: 29px;">thirdCodeFamilySet</td><td style="width: 20%; height: 29px;">List&lt;[CodeFamilyInfoBO](https://book.e-buy.com/books/e-buy-40/page/a5bfc)&gt;</td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;"> </td><td style="width: 20%; height: 29px;"> </td></tr></tbody></table>

**返回报文举例**

```JSON
{
	"returnCode": "00",
    "returnMsg": "SUCCESS",
    "sendChannelOrderId": "",
    "thirdCodeFamilySet": []
}
```

# 测试apimock同步

\[yapi\_interface\]617\[/yapi\_interface\]

# 查询码信息查询

<h4 id="bkmrk-%E6%8E%A5%E5%8F%A3%E7%94%A8%E9%80%94"><strong>接口用途</strong></h4>
<ul id="bkmrk-%E5%BD%93%E9%9C%80%E8%A6%81%E6%9F%A5%E8%AF%A2%E6%9F%90%E4%B8%AA%E6%8C%87%E5%AE%9A%E7%A0%81%E6%97%B6%EF%BC%8C%E5%8F%96%E7%A0%81%E6%96%B9%E8%B0%83%E7%94%A8%E6%AD%A4%E6%8E%A5%E5%8F%A3"><li>当需要查询某个指定码时，取码方调用此接口</li>
</ul><h4 id="bkmrk-%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E"><strong>接口说明</strong></h4>
<ul id="bkmrk-%E7%A0%81%E8%A1%A8%E4%B8%AD%E4%BB%A5%E6%8E%A9%E7%A0%81%E4%B8%BA%E5%88%86%E8%A1%A8%E4%BD%8D%EF%BC%8C%E6%AF%8F%E6%9F%A5%E8%AF%A2%E6%9F%90%E4%B8%AA%E7%A0%81%E6%97%B6%E5%BF%85%E9%A1%BB"><li>码表中以掩码为分表位，每查询某个码时必须有明确的码号。</li>
</ul><h4 id="bkmrk-action"><strong>action</strong></h4>
<ul id="bkmrk-codequery"><li><code>CodeQueryBySearchCode</code></li>
</ul><p id="bkmrk-%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%EF%BC%8Cchannel%3D%3D%3D%3Ewhal"><strong>请求参数，CHANNEL===&gt;<a class="glossary-term" title="易百电子凭证4.0系统的别称" href="https://book.e-buy.com/books/e-buy-40/page/7f100">WHALE</a></strong></p>
<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>requestId</td>
<td>String</td>
<td>是</td>
<td>请求流水号</td>
<td>32个字符，用于标识唯一一笔交易</td>
</tr><tr><td>codes</td>
<td>List</td>
<td>是</td>
<td>验码集合</td>
<td>&nbsp;</td>
</tr><tr><td>brandId</td>
<td>String</td>
<td>否</td>
<td>核销门店所属品牌</td>
<td>组合劵必须上送，易百提供</td>
</tr><tr><td>cityId</td>
<td>String</td>
<td>否</td>
<td>门店所在城市id</td>
<td>易百提供的城市id</td>
</tr><tr><td>storeInfo</td>
<td>Object&lt;<a title="storeInfo" href="https://book.e-buy.com/books/e-buy-40/page/54229">storeInfo</a>&gt;</td>
<td>否</td>
<td>门店串码查询时上送</td>
</tr></tbody></table><p id="bkmrk-%E8%AF%B7%E6%B1%82%E6%8A%A5%E6%96%87%E4%B8%BE%E4%BE%8B"><strong>请求报文举例</strong></p>
<pre id="bkmrk-%7B-%22requestid%22%3A-%222018"><code class="language-">{
    "requestId": "20181019112535100000000000000002",
    "codes": ["1021242013780905000"],
    "brandId":"2429",
    "cityId":5493
}
</code></pre>
<p id="bkmrk-%E8%BF%94%E5%9B%9E%E5%8F%82%E6%95%B0%EF%BC%8Cwhale%3D%3D%3D%3Echanne"><strong>返回参数，<a class="glossary-term" title="易百电子凭证4.0系统的别称" href="https://book.e-buy.com/books/e-buy-40/page/7f100">WHALE</a>===&gt;CHANNEL</strong></p>
<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-0"><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>&nbsp;</td>
</tr><tr><td>returnMsg</td>
<td>String</td>
<td>是</td>
<td>请求返回信息</td>
<td>&nbsp;</td>
</tr><tr><td>data</td>
<td>Object&lt;<a title="codeQueryResponseData" href="https://book.e-buy.com/books/e-buy-40/page/0584c">codeQueryResponseData</a>&gt;</td>
<td>否</td>
<td>码信息</td>
</tr></tbody></table><p id="bkmrk-%E8%BF%94%E5%9B%9E%E6%8A%A5%E6%96%87%E4%B8%BE%E4%BE%8B"><strong>返回报文举例</strong></p>
<pre id="bkmrk-%7B-%22returncode%22%3A-%2200%22"><code class="language-">{
    "returnCode": "00",
    "returnMsg": "操作成功",
    "requestId": "171698602301",
    "data":{
        "codeDetail":[{
            "code":"1021242013780905000",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "saleChannelCode":"990001",
            "useTimes":1,
            "verifyTimes":1
            "remainTimes":0,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        },{
            "code":"1021242013780905001",
            "saleChannelOrderId":"20181120155110",
            "sendChannelName":"易百自制渠道",
            "remainTimes":1,
            "createDate": "20180905",
            "createTime": "20180905160911",
            "validStart":"20181123000000",
            "validEnd":"20181124235959",
            "verifyDate":"20181123",
            "verifyTime":"20181124121243",
            "status": "01",
            "statusDesc": "已使用",
            "cityCheck":"Y",
            "ticketId":"9000000001",
            "faceValue":3000,
            "ticketName":"星巴克30元代金券",
            "shopNo":"1111",
            "shopName":"星巴克测试门店"
            "faceValue":1000,
        }]
    }
}
</code></pre>
<h4 id="bkmrk-%E5%88%B8%E7%8A%B6%E6%80%81%E6%9E%9A%E4%B8%BE"><strong>券状态枚举</strong></h4>
<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-00-%E5%8F%AF%E4%BD%BF%E7%94%A8-01"><thead><tr><th>字段</th>
<th>字段意义</th>
<th>备注</th>
</tr></thead><tbody><tr><td>00</td>
<td>可使用</td>
</tr><tr><td>01</td>
<td>已使用</td>
</tr><tr><td>02</td>
<td>可使用(一码多次使用时，码还有可用次数)</td>
</tr><tr><td>03</td>
<td>未激活</td>
<td>未激活的码需调用激活接口才能</td>
</tr><tr><td>04</td>
<td>已冻结</td>
</tr><tr><td>05</td>
<td>已作废</td>
</tr><tr><td>06</td>
<td>已过期</td>
<td>&nbsp;</td>
</tr><tr><td>07</td>
<td>未生效</td>
<td>当制码时选择次日生效，核销时会返回该状态</td>
</tr><tr><td>09</td>
<td>券不存在</td>
<td>&nbsp;</td>
</tr><tr><td>35</td>
<td>码配置异常</td>
</tr></tbody></table>

# 现金卡预核销

[yapi_interface]14869[/yapi_interface]