# ESB转发类接口--http转发请求接口



# http转发请求数据

### 第三方码实时作废请求报文

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

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>thirdCodeId</td><td>String</td><td>否</td><td>制码时返回的第三方码id</td><td> </td></tr><tr><td>sendChannelOrderId</td><td>String</td><td>否</td><td>制码时制码订单号</td><td> </td></tr><tr><td>whaleTicketId</td><td>String</td><td>是</td><td>易百券id</td><td> </td></tr><tr><td>channelTicketId</td><td>String</td><td>否</td><td>制码方分配的产品id</td><td> </td></tr><tr><td>codeRemark</td><td>String</td><td>否</td><td>码备注信息</td></tr></tbody></table>

### 第三方码核销转发请求报文

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

<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-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>verifyScene</td><td>String</td><td>是</td><td>核销场景</td><td>online：线上，offline：线下</td></tr><tr><td>tid</td><td>String</td><td>否</td><td>易百终端id</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>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></tr></tbody></table>

### 第三方码核销转发返回报文

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

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>thirdTicketId</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>thirdTicketName</td><td>String</td><td>是</td><td>核销场景</td><td>online：线上，offline：线下</td></tr><tr><td>thirdActivityId</td><td>String</td><td>否</td><td>易百终端id</td><td>线下核销场景存在机具信息时必填</td></tr><tr><td>thirdActivityName</td><td>String</td><td>否</td><td>易百门店编号</td><td>线下核销场景存在机具信息时必填</td></tr><tr><td>verifyTime</td><td>String</td><td>否</td><td>易百门店名称</td><td>线下核销场景存在机具信息时必填</td></tr><tr><td>verifyFundsChannel</td><td>Object&lt;[verifyFundsChannel](https://book.e-buy.com/books/e-buy-40/page/http "verifyFundsChannel")&gt;</td><td>否</td><td>第三方码核销转发资金渠道</td><td> </td></tr><tr><td>returnCode</td><td>String(2)</td><td>是</td><td>第三方核销结果码</td><td>00：成功，其他均为失败</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>第三方核销结果</td></tr></tbody></table>

#### 第三方码核销转发资金渠道

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

<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-f"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>faceValue</td><td>Number</td><td>否</td><td>面值，券面金额</td><td> </td></tr><tr><td>settlementAmount</td><td>Number</td><td>否</td><td>结算金额</td><td> </td></tr><tr><td>discountAmount</td><td>Number</td><td>否</td><td>折抵金额</td><td> </td></tr><tr><td>channelDiscountAmount</td><td>Number</td><td>否</td><td>渠道折抵金额</td><td> </td></tr><tr><td>merchantDiscountAmount</td><td>Number</td><td>否</td><td>商户折抵金额</td><td> </td></tr><tr><td>totalAmount</td><td>Number</td><td>否</td><td>购买时订单总金额</td><td> </td></tr><tr><td>userRealAmount</td><td>Number</td><td>否</td><td>购买时用户实付</td><td> </td></tr><tr><td>merchantRealAmount</td><td>Number</td><td>否</td><td>商户实收金额</td><td> </td></tr><tr><td>benefitAmount</td><td>Number</td><td>否</td><td>购买时总优惠金额</td><td> </td></tr><tr><td>channelBenefit</td><td>Number</td><td>否</td><td>购买时渠道优惠</td><td> </td></tr><tr><td>merchantBenefit</td><td>Number</td><td>否</td><td>购买时商户优惠</td></tr></tbody></table>

### 第三方码查询转发请求报文

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

<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-1"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>流水号</td><td> </td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>易百终端id</td></tr></tbody></table>

### 第三方码查询转发返回报文

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

<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-2"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>codeStatus</td><td>String</td><td>是</td><td>码状态</td><td>见下文</td></tr><tr><td>codeStatusDesc</td><td>String</td><td>是</td><td>码状态描述</td><td> </td></tr><tr><td>codeValidStart</td><td>String</td><td>是</td><td>码有效期开始时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>codeValidEnd</td><td>String</td><td>是</td><td>码有效期结束时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>purchaseTime</td><td>String</td><td>是</td><td>电子凭证购买时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>verifyDate</td><td>String</td><td>否</td><td>核销日期</td><td>yyyyMMdd</td></tr><tr><td>verifyTime</td><td>String</td><td>是</td><td>核销时间</td><td>yyyyMMddHHmmss</td></tr><tr><td>ebuyTicketId</td><td>String</td><td>否</td><td>易百产品id</td><td>当第三方返回报文里有易百产品信息则必填</td></tr><tr><td>ebuyTicketName</td><td>String</td><td>否</td><td>易百产品名称</td><td>当第三方返回报文里有易百产品信息则必填</td></tr><tr><td>thirdTicketId</td><td>String</td><td>是</td><td>第三方产品id</td><td> </td></tr><tr><td>thirdTicketName</td><td>String</td><td>是</td><td>第三方产品名称</td><td> </td></tr><tr><td>ebuyActivityId</td><td>String</td><td>否</td><td>易百活动id</td><td> </td></tr><tr><td>ebuyActivityName</td><td>String</td><td>否</td><td>易百活动名称</td><td> </td></tr><tr><td>thirdActivityId</td><td>String</td><td>否</td><td>第三方活动id</td><td> </td></tr><tr><td>thirdActivityName</td><td>String</td><td>否</td><td>第三方活动名称</td><td> </td></tr><tr><td>returnCode</td><td>String(2)</td><td>是</td><td>第三方查询结果码</td><td>00：成功，其他均为失败</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>第三方查询呢结果</td></tr></tbody></table>

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

<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> </td></tr><tr><td>07</td><td>未生效</td><td>当制码时选择次日生效，核销时会返回该状态</td></tr><tr><td>09</td><td>码异常，不能用</td></tr></tbody></table>

# 新页面



# 第三方码激活

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

- 当电子凭证平台需要调用外部制码方激活接口对某些码进行激活时，调用该接口。

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

- 该接口为电子凭证平台调用ESB做激活操作，ESB再根据不同制码方拼装报文并实时请求。

#### **url**

- `activityInsert`

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

<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>channelId</td><td>String</td><td>是</td><td>外部制码方id</td><td> </td></tr><tr><td>requestId</td><td>String(32)</td><td>是</td><td>请求流水号</td><td> </td></tr><tr><td>codeArray</td><td>List</td><td>是</td><td>待激活码</td><td> </td></tr><tr><td>validStart</td><td>String</td><td>是</td><td>码有效开始时间</td><td> </td></tr><tr><td>validEnd</td><td>String</td><td>是</td><td>码有效结束时间</td></tr></tbody></table>

**请求报文举例**

```
{
    "channelId":"10002401",
    "requestId": "20180905112600001",
    "codeArray": ["100809051126021", "100809051126022"],
    "validStart": "20180905112600",
    "validEnd": "20181005112600"
}

```

**返回参数，ESB===&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></tr></tbody></table>

**返回报文举例**

```
{
    "returnCode": "00",
    "returnMsg": "SUCCESS"
}
```

# 第三方码作废

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

- 当电子凭证平台需要调用外部制码方码作废接口对某些码进行作废时，调用该接口。

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

- 该接口为电子凭证平台调用ESB做激活操作，ESB再根据不同制码方拼装报文并实时请求。

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

<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>channelId</td><td>String</td><td>是</td><td>制码方id</td><td> </td></tr><tr><td>optTag</td><td>String</td><td>是</td><td>操作类型</td><td>ThirdCodeVoid</td></tr><tr><td>transferUrl</td><td>String</td><td>是</td><td>通知地址</td><td> </td></tr><tr><td>messageType</td><td>String</td><td>是</td><td>报文类型</td><td>Ebuy:易百标准报文格式，Third:第三方自定义格式</td></tr><tr><td>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td><td>内容如下文</td></tr></tbody></table>

**易百标准报文：第三方码实时作废**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String(10)</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String(20)</td><td>是</td><td>业务标识</td><td>ThirdCodeVoid</td></tr><tr><td>bizContent</td><td>String&lt;[thirdCodeVoidData](https://book.e-buy.com/books/e-buy-40/page/http "thirdCodeVoidData")&gt;</td><td>是</td><td>第三方码实时作废数据</td><td>需要base64解码</td></tr><tr><td>version</td><td>String(10)</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**返回参数，ESB===&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-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>channelId</td><td>String</td><td>是</td><td>渠道id。原样返回</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号。原样返回</td><td> </td></tr><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></tr></tbody></table>

# 第三方码核销转发

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

- 当电子凭证平台需要调用外部制码方进行核销时，调用该接口。

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

- 该接口为电子凭证平台调用ESB做核销操作，ESB再根据不同制码方拼装报文并实时请求。

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

<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>channelId</td><td>String</td><td>是</td><td>制码方id</td><td> </td></tr><tr><td>transferAction</td><td>String</td><td>是</td><td>操作类型</td><td>ThirdCodeVerify</td></tr><tr><td>transferUrl</td><td>String</td><td>是</td><td>通知地址</td><td> </td></tr><tr><td>messageType</td><td>String</td><td>是</td><td>报文类型</td><td>Ebuy:易百标准报文格式，Third:第三方自定义格式</td></tr><tr><td>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td><td>内容如下文</td></tr></tbody></table>

**易百标准报文：第三方码实时核销请求报文**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String(10)</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String(20)</td><td>是</td><td>业务标识</td><td>ThirdCodeVerify</td></tr><tr><td>bizContent</td><td>String&lt;[thirdVerifyTransferRequest](https://book.e-buy.com/books/e-buy-40/page/http "thirdVerifyTransferRequest")&gt;</td><td>是</td><td>第三方码实时作废数据</td><td>需要base64解码</td></tr><tr><td>version</td><td>String(10)</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**返回参数，ESB===&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-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>channelId</td><td>String</td><td>是</td><td>渠道id。原样返回</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号。原样返回</td><td> </td></tr><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>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td><td>内容如下文</td></tr></tbody></table>

**易百标准报文：第三方码实时核销返回报文**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String(10)</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String(20)</td><td>是</td><td>业务标识</td><td>ThirdCodeVerify</td></tr><tr><td>bizContent</td><td>String&lt;[thirdVerifyTransferResponse](https://book.e-buy.com/books/e-buy-40/page/http "thirdVerifyTransferResponse")&gt;</td><td>是</td><td>第三方码实时作废数据</td><td>需要base64解码</td></tr><tr><td>version</td><td>String(10)</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

# 第三方码查询转发

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

- 当电子凭证平台需要调用外部制码方进行查询时，调用该接口。

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

- 该接口为电子凭证平台调用ESB做查询操作，ESB再根据不同制码方拼装报文并实时请求。

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

<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>channelId</td><td>String</td><td>是</td><td>制码方id</td><td> </td></tr><tr><td>transferAction</td><td>String</td><td>是</td><td>操作类型</td><td>ThirdCodeQuery</td></tr><tr><td>transferUrl</td><td>String</td><td>是</td><td>通知地址</td><td> </td></tr><tr><td>messageType</td><td>String</td><td>是</td><td>报文类型</td><td>Ebuy:易百标准报文格式，Third:第三方自定义格式</td></tr><tr><td>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td><td>内容如下文</td></tr></tbody></table>

**易百标准报文：第三方码实时查询请求报文**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String(10)</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String(20)</td><td>是</td><td>业务标识</td><td>ThirdCodeQuery</td></tr><tr><td>bizContent</td><td>String&lt;[thirdQueryTransferRequest](https://book.e-buy.com/books/e-buy-40/page/http "thirdQueryTransferRequest")&gt;</td><td>是</td><td>第三方码实时查询数据</td><td>需要base64解码</td></tr><tr><td>version</td><td>String(10)</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

**返回参数，ESB===&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-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>channelId</td><td>String</td><td>是</td><td>渠道id。原样返回</td><td> </td></tr><tr><td>requestId</td><td>String</td><td>是</td><td>请求流水号。原样返回</td><td> </td></tr><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>whaleMessage</td><td>String</td><td>是</td><td>易百标准报文</td><td>内容如下文</td></tr></tbody></table>

**易百标准报文：第三方码实时查询返回报文**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-a-0"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>appId</td><td>String(10)</td><td>是</td><td>电子凭证系统对接方id</td><td> </td></tr><tr><td>action</td><td>String(20)</td><td>是</td><td>业务标识</td><td>ThirdCodeQuery</td></tr><tr><td>bizContent</td><td>String&lt;[thirdQueryTransferResponse](https://book.e-buy.com/books/e-buy-40/page/http "thirdQueryTransferResponse")&gt;</td><td>是</td><td>第三方码实时查询数据</td><td>需要base64解码</td></tr><tr><td>version</td><td>String(10)</td><td>是</td><td>版本号</td></tr><tr><td>timestamp</td><td>String</td><td>是</td><td>时间戳</td><td> </td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名</td></tr></tbody></table>

# 易百码核销转发

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

- 当电子凭证平台需要调用外部取码方进行查询时，调用该接口。

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

- 该接口为电子凭证平台调用ESB做查询操作，ESB再根据不同制码方拼装报文并实时请求。

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

<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>verifyUrl</td><td>String</td><td>是</td><td>取码方核销地址</td><td> </td></tr><tr><td>saleChannelId</td><td>String</td><td>是</td><td>取码方渠道id</td><td> </td></tr><tr><td>code</td><td>String</td><td>是</td><td>串码号</td><td> </td></tr><tr><td>saleChannelOrderId</td><td>String</td><td>是</td><td>取码方制码订单号</td><td> </td></tr><tr><td>verifyScene</td><td>String</td><td>是</td><td>核销场景</td><td>online：线上，offline：线下</td></tr><tr><td>brandId</td><td>String</td><td>否</td><td>品牌id</td></tr><tr><td>tid</td><td>String</td><td>否</td><td>易百终端id</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>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>messageFormat</td><td>String</td><td>是</td><td>核销转发报文格式</td><td>ebuy：易百标准报文，third：第三方自定义报文</td></tr></tbody></table>

**返回参数：易百码核销转发报文**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-c"><thead><tr><th>字段</th><th>类型</th><th>是否必填</th><th>字段意义</th><th>备注</th></tr></thead><tbody><tr><td>channelId</td><td>String</td><td>是</td><td>电子凭证系统对接方id</td><td>对应请求报文中saleChannelOrderId字段</td></tr><tr><td>returnCode</td><td>String</td><td>是</td><td>返回码</td><td>00：成功，其他均为失败。两位数字和字母组合</td></tr><tr><td>returnMsg</td><td>String</td><td>是</td><td>返回信息</td></tr></tbody></table>