# 线上交易类接口



# 同步单品发码（单个&批量发码与激活）

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

- 支持请码方一次单品请求调用,单品发码数量上限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": "未使用"
            }]
        }]
    }
}
```

# 码作废（退款）接口

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

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

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

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

#### **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>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>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**

- `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",
            ...
            }],
    }
}
```

# 码信息更新接口

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

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

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

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

#### **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"
    }
}
```

# 码信息查询

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

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

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

- 码表中以掩码为分表位，每查询某个码时必须有明确的码号。
- 如果券码预售提前激活，还未生效前  
    1、抖音本地， 直接返回券码状态不做拦截，核销时候会拦截无法使用  
    2、其他的渠道直接返回 券码不在有效期

#### **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>

# 批量码核销

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

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

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

- 一次可以多码核销,一次最多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](https://book.e-buy.com/books/c20ad/page/17d63)</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"
        }
    ],
    "remark": {
        "oms": "test001"
    }
}
```

**返回参数，[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 元现金抵价券 "
        }]
    }
}
```

# 测试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>