# 卡券管理类接口列表



# 批量激活卡券

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

- 供门店激活一批卡或券

#### **接口地址**

- `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchActivate`

#### **action**

- batchActivate

**请求参数，中间件===>易百后台**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="width: 1084px; height: 396.75px;"><thead><tr style="height: 29.7969px;"><th style="width: 153.391px; height: 29.7969px;">字段</th><th style="width: 144.375px; height: 29.7969px;">类型</th><th style="width: 79.375px; height: 29.7969px;">是否必填</th><th style="width: 147.391px; height: 29.7969px;">字段意义</th><th style="width: 421.391px; height: 29.7969px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">traceNo</td><td style="width: 144.375px; height: 29.7969px;">String</td><td style="width: 79.375px; height: 29.7969px;">是</td><td style="width: 147.391px; height: 29.7969px;">收银机流水号</td><td style="width: 421.391px; height: 29.7969px;">不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr style="height: 46.5938px;"><td style="width: 153.391px; height: 46.5938px;">onlineTid</td><td style="width: 144.375px; height: 46.5938px;">String</td><td style="width: 79.375px; height: 46.5938px;">否</td><td style="width: 147.391px; height: 46.5938px;">线上对接使用的统一终端号</td><td style="width: 421.391px; height: 46.5938px;">对接前需提前和易百技术沟通</td></tr><tr><td style="width: 153.391px;">activateType</td><td style="width: 144.375px;">String</td><td style="width: 79.375px;">是</td><td style="width: 147.391px;">激活类型</td><td style="width: 421.391px;">1：券；2：预付卡</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">posOrderNo</td><td style="width: 144.375px; height: 29.7969px;">String</td><td style="width: 79.375px; height: 29.7969px;">是</td><td style="width: 147.391px; height: 29.7969px;">pos订单号</td><td style="width: 421.391px; height: 29.7969px;">pos订单号，由商家自定义需保证在商户端不重复</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">totalAmount</td><td style="width: 144.375px; height: 29.7969px;">Price</td><td style="width: 79.375px; height: 29.7969px;">是</td><td style="width: 147.391px; height: 29.7969px;">交易总金额</td><td style="width: 421.391px; height: 29.7969px;">单位：元</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">userRealAmount</td><td style="width: 144.375px; height: 29.7969px;">Price</td><td style="width: 79.375px; height: 29.7969px;">是</td><td style="width: 147.391px; height: 29.7969px;">用户实付</td><td style="width: 421.391px; height: 29.7969px;">单位：元</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">receiptAmount</td><td style="width: 144.375px; height: 29.7969px;">Price</td><td style="width: 79.375px; height: 29.7969px;">是</td><td style="width: 147.391px; height: 29.7969px;">商户实收金额</td><td style="width: 421.391px; height: 29.7969px;">单位：元</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">codeValidDays</td><td style="width: 144.375px; height: 29.7969px;">Number</td><td style="width: 79.375px; height: 29.7969px;">否</td><td style="width: 147.391px; height: 29.7969px;">相对有效天数</td><td class="align-left" rowspan="3" style="height: 89.3907px; width: 421.391px;">码相对有效期天数和码有效开始结束时间段任选其一必填</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">codeValidStart</td><td style="width: 144.375px; height: 29.7969px;">String</td><td style="width: 79.375px; height: 29.7969px;">否</td><td style="width: 147.391px; height: 29.7969px;">码有效开始时间</td></tr><tr style="height: 29.7969px;"><td style="width: 153.391px; height: 29.7969px;">codeValidEnd</td><td style="width: 144.375px; height: 29.7969px;">String</td><td style="width: 79.375px; height: 29.7969px;">否</td><td style="width: 147.391px; height: 29.7969px;">码有效结束时间</td></tr><tr style="height: 35.3906px;"><td style="width: 153.391px; height: 35.3906px;">codeDetail</td><td style="width: 144.375px; height: 35.3906px;">List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-B6z/page/f1b6f "codeDetail")&gt;</td><td style="width: 79.375px; height: 35.3906px;">是</td><td style="width: 147.391px; height: 35.3906px;">待激活卡券列表</td><td style="width: 421.391px; height: 35.3906px;">  
</td></tr><tr style="height: 46.5938px;"><td style="width: 153.391px; height: 46.5938px;">orderRemark</td><td style="width: 144.375px; height: 46.5938px;">String</td><td style="width: 79.375px; height: 46.5938px;">否</td><td style="width: 147.391px; height: 46.5938px;">订单备注</td><td style="width: 421.391px; height: 46.5938px;">订单备注信息，除基本信息，也用于部分透传字段场景使用</td></tr></tbody></table>

**请求报文举例**

```json
{
    "traceNo": "TEST16876705239999000001",
    "onlineTid": "",
    "activateType": "1",
    "posOrderNo": "batchActivate1687670523",
    "totalAmount": "100",
    "userRealAmount": "100",
    "receiptAmount": "100",
    "codeValidDays": "100",
    "codeValidStart": "2023-06-18",
    "codeValidEnd": "2023-12-31",
    "codeDetail": [
        {
            "code": "10032812043865714308",
        }
    ]
}
```

**返回参数，易百后台===&gt;中件间**

<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-0" style="width: 919px;"><thead><tr><th style="width: 115.547px;">字段</th><th style="width: 123.547px;">类型</th><th style="width: 83.5469px;">是否必填</th><th style="width: 153.547px;">字段意义</th><th style="width: 405.547px;">备注</th></tr></thead><tbody><tr><td style="width: 115.547px;">traceNo</td><td style="width: 123.547px;">String</td><td style="width: 83.5469px;">是</td><td style="width: 153.547px;">收银机流水号</td><td style="width: 405.547px;">不允许重复</td></tr><tr><td style="width: 115.547px;">orderNo</td><td style="width: 123.547px;">String</td><td style="width: 83.5469px;">是</td><td style="width: 153.547px;">本次激活操作订单号</td><td style="width: 405.547px;"> </td></tr><tr><td style="width: 115.547px;">transDate</td><td style="width: 123.547px;">String</td><td style="width: 83.5469px;">是</td><td style="width: 153.547px;">交易时间</td><td style="width: 405.547px;">格式为：yyyyMMddHHmmss</td></tr><tr><td style="width: 115.547px;">returnCode</td><td style="width: 123.547px;">String</td><td style="width: 83.5469px;">是</td><td style="width: 153.547px;">返回码</td><td style="width: 405.547px;">00仅表示本次请求成功，并不代表所有码都激活成功</td></tr><tr><td style="width: 115.547px;">returnDesc</td><td style="width: 123.547px;">String</td><td style="width: 83.5469px;">是</td><td style="width: 153.547px;">返回信息</td><td style="width: 405.547px;">交易结果描述或错误原因</td></tr><tr><td style="width: 115.547px; height: 35.3906px;">codeDetail</td><td style="width: 123.547px; height: 35.3906px;">List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-B6z/page/f1b6f "codeDetail")&gt;</td><td style="width: 83.5469px; height: 35.3906px;">是</td><td style="width: 153.547px; height: 35.3906px;">激活结果列表</td><td style="width: 405.547px;">  
</td></tr><tr style="height: 45px;"><td style="width: 115.547px; height: 45px;">orderRemark</td><td style="width: 123.547px; height: 45px;">String</td><td style="width: 83.5469px; height: 45px;">否</td><td style="width: 153.547px; height: 45px;">订单备注</td><td style="width: 405.547px; height: 45px;">订单备注信息，除基本信息，也用于部分透传字段场景使用</td></tr></tbody></table>

**返回报文举例**

```json
{
   	"returnCode": "00",
	"returnDesc": "交易成功",
    "codeDetail": [
        {
            "code": "10032812043865714308",
            "resultCode": "SUCCESS",
            "resultDesc": "交易成功",
            "ticketId": "1000030000057",
            "ticketName": "测试预付费",
            "useTimes": 1
        }
    ],
    "traceNo": "TEST16876705239999000001",
    "transDate": "20230625132210"
}
```

# 批量取消激活卡券

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

- 供门店取消激活一批卡或券

#### **接口地址**

- `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/batchUnActivate`

#### **action**

- `batchUnActivate`

**请求参数，中间件===&gt;易百后台**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="height: 262.766px; width: 809px;"><thead><tr style="height: 29.7969px;"><th style="width: 97px;">字段</th><th style="width: 125.594px; height: 29.7969px;">类型</th><th style="width: 74px; height: 29.7969px;">是否必填</th><th style="width: 132.125px; height: 29.7969px;">字段意义</th><th style="width: 443.922px; height: 29.7969px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 97px;">traceNo</td><td style="width: 125.594px; height: 29.7969px;">String</td><td style="width: 74px; height: 29.7969px;">是</td><td style="width: 132.125px; height: 29.7969px;">收银机流水号</td><td style="width: 443.922px; height: 29.7969px;">不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr style="height: 46.5938px;"><td style="width: 97px;">onlineTid</td><td style="width: 125.594px; height: 46.5938px;">String</td><td style="width: 74px; height: 46.5938px;">否</td><td style="width: 132.125px; height: 46.5938px;">线上对接使用的统一终端号</td><td style="width: 443.922px; height: 46.5938px;">对接前需提前和易百技术沟通</td></tr><tr style="height: 29.7969px;"><td style="width: 97px;">codeDetail</td><td style="width: 125.594px;">List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-B6z/page/f1b6f "codeDetail")&gt;</td><td style="width: 74px;">否</td><td style="width: 132.125px;">待取消激活卡券列表</td><td style="width: 443.922px; height: 29.7969px;">券号列表</td></tr><tr><td style="width: 97px;">originalTraceNo</td><td style="width: 125.594px;">String</td><td style="width: 74px;">否</td><td style="width: 132.125px;">原激活交易收银机流水号</td><td style="width: 443.922px;">传入需要取消激活原交易收银机流水号Costa品牌必传</td></tr><tr style="height: 46.5938px;"><td style="width: 97px; height: 45px;">orderRemark</td><td style="width: 125.594px; height: 46.5938px;">String</td><td style="width: 74px; height: 46.5938px;">否</td><td style="width: 132.125px; height: 46.5938px;">订单备注</td><td style="width: 443.922px; height: 46.5938px;">订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。</td></tr></tbody></table>

**请求报文举例**

```json
{
    "traceNo": "TEST16876718849999000003",
    "onlineTid": "",
    "codeDetail": [
        {
            "code": "10032812043892009242"
        }
    ]
}
```

**返回参数，易百后台===&gt;中件间**

<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-0" style="height: 286px; width: 809px;"><thead><tr style="height: 45px;"><th style="width: 93px; height: 45px;">字段</th><th style="width: 133px; height: 45px;">类型</th><th style="width: 48px; height: 45px;">是否必填</th><th style="width: 146px; height: 45px;">字段意义</th><th style="width: 389px; height: 45px;">备注</th></tr></thead><tbody><tr style="height: 45px;"><td style="width: 93px; height: 45px;">traceNo</td><td style="width: 133px; height: 45px;">String</td><td style="width: 48px; height: 45px;">是</td><td style="width: 146px; height: 45px;">收银机流水号</td><td style="width: 389px; height: 45px;">不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">orderNo</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">本次作废操作订单号</td><td style="width: 389px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">transDate</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">交易时间</td><td style="width: 389px; height: 29px;">格式为：yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">returnCode</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">返回码</td><td style="width: 389px; height: 29px;">00仅表示本次请求成功，并不代表所有码都取消激活成功</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">returnDesc</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">返回信息</td><td style="width: 389px; height: 29px;">交易结果描述或错误原因</td></tr><tr style="height: 51px;"><td style="width: 93px; height: 51px;">codeDetail</td><td style="width: 133px; height: 51px;">List&lt;[codeDetail](https://book.e-buy.com/books/e-buy-B6z/page/f1b6f "codeDetail")&gt;</td><td style="width: 48px; height: 51px;">是</td><td style="width: 146px; height: 51px;">取消激活结果列表</td><td style="width: 389px; height: 51px;">  
</td></tr><tr style="height: 45px;"><td style="width: 93px; height: 45px;">orderRemark</td><td style="width: 133px; height: 45px;">String</td><td style="width: 48px; height: 45px;">否</td><td style="width: 146px; height: 45px;">订单备注</td><td style="width: 389px; height: 45px;">订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。</td></tr></tbody></table>

**返回报文举例**

```json
{
	"returnCode": "00",
	"returnDesc": "交易成功",
    "codeDetail": [
        {
            "code": "10032812043892009242",
            "resultCode": "SUCCESS",
            "resultDesc": "交易成功",
            "ticketId": "1000030000057",
            "ticketName": "测试预付费",
            "useTimes": 1
        }
    ],
    "traceNo": "TEST16876718849999000003",
    "transDate": "20230625134444"
}
```

# 按礼品卡号查询卡信息

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

- 供门店查询卡相关信息

#### **接口地址**

- `https://ebuywebposp-test.e-buychina.com/ebuyweb-posp/api/getCardInfo`

#### **action**

- `getCardInfo`

**请求参数，中间件===&gt;易百后台**

<table id="bkmrk-%E5%AD%97%E6%AE%B5-%E7%B1%BB%E5%9E%8B-%E6%98%AF%E5%90%A6%E5%BF%85%E5%A1%AB-%E5%AD%97%E6%AE%B5%E6%84%8F%E4%B9%89-%E5%A4%87%E6%B3%A8-t" style="height: 262.766px; width: 809px;"><thead><tr style="height: 29.7969px;"><th style="width: 97px;">字段</th><th style="width: 125.594px; height: 29.7969px;">类型</th><th style="width: 74px; height: 29.7969px;">是否必填</th><th style="width: 132.125px; height: 29.7969px;">字段意义</th><th style="width: 443.922px; height: 29.7969px;">备注</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 97px;">traceNo</td><td style="width: 125.594px; height: 29.7969px;">String</td><td style="width: 74px; height: 29.7969px;">是</td><td style="width: 132.125px; height: 29.7969px;">收银机流水号</td><td style="width: 443.922px; height: 29.7969px;">不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr style="height: 46.5938px;"><td style="width: 97px;">onlineTid</td><td style="width: 125.594px; height: 46.5938px;">String</td><td style="width: 74px; height: 46.5938px;">否</td><td style="width: 132.125px; height: 46.5938px;">线上对接使用的统一终端号</td><td style="width: 443.922px; height: 46.5938px;">对接前需提前和易百技术沟通</td></tr><tr style="height: 29.7969px;"><td style="width: 97px;">cardNo</td><td style="width: 125.594px;">String</td><td style="width: 74px;">是</td><td style="width: 132.125px;">礼品卡卡号</td><td style="width: 443.922px; height: 29.7969px;">卡号</td></tr><tr style="height: 46.5938px;"><td style="width: 97px; height: 45px;">orderRemark</td><td style="width: 125.594px; height: 46.5938px;">String</td><td style="width: 74px; height: 46.5938px;">否</td><td style="width: 132.125px; height: 46.5938px;">订单备注</td><td style="width: 443.922px; height: 46.5938px;">订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。</td></tr></tbody></table>

**请求报文举例**

```json
{
    "traceNo": "TEST16876718849999000003",
    "onlineTid": "",
    "cardNo": "9531761027959980000026"
}
```

**返回参数，易百后台===&gt;中件间**

<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-0" style="height: 286px; width: 809px;"><thead><tr style="height: 45px;"><th style="width: 93px; height: 45px;">字段</th><th style="width: 133px; height: 45px;">类型</th><th style="width: 48px; height: 45px;">是否必填</th><th style="width: 146px; height: 45px;">字段意义</th><th style="width: 389px; height: 45px;">备注</th></tr></thead><tbody><tr style="height: 45px;"><td style="width: 93px; height: 45px;">traceNo</td><td style="width: 133px; height: 45px;">String</td><td style="width: 48px; height: 45px;">是</td><td style="width: 146px; height: 45px;">收银机流水号</td><td style="width: 389px; height: 45px;">不允许重复，必须以yyyyMMdd(当天)作为流水号开头+递增序列</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">orderNo</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">本次查询操作易百交易号</td><td style="width: 389px; height: 29px;">  
</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">transDate</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">交易时间</td><td style="width: 389px; height: 29px;">格式为：yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">returnCode</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">返回码</td><td style="width: 389px; height: 29px;">00表示本次查询请求成功</td></tr><tr style="height: 29px;"><td style="width: 93px; height: 29px;">returnDesc</td><td style="width: 133px; height: 29px;">String</td><td style="width: 48px; height: 29px;">是</td><td style="width: 146px; height: 29px;">返回信息</td><td style="width: 389px; height: 29px;">交易结果描述或错误原因</td></tr><tr style="height: 51px;"><td style="width: 93px; height: 51px;">cardInfo</td><td style="width: 133px; height: 51px;">Object&lt;[cardInfo](https://book.e-buy.com/books/e-buy-B6z/page/6cdd6 "cardInfo")&gt;</td><td style="width: 48px; height: 51px;">是</td><td style="width: 146px; height: 51px;">礼品卡信息</td><td style="width: 389px; height: 51px;">当returnCode为00时才返回</td></tr><tr style="height: 45px;"><td style="width: 93px; height: 45px;">orderRemark</td><td style="width: 133px; height: 45px;">String</td><td style="width: 48px; height: 45px;">否</td><td style="width: 146px; height: 45px;">订单备注</td><td style="width: 389px; height: 45px;">订单备注信息，除基本信息，也用于部分透传字段场景使用，如品牌核销渠道等。</td></tr></tbody></table>

**返回报文举例**

```json
{
	"returnCode": "00",
	"returnDesc": "交易成功",
	"cardInfo": {
		"cardNo": "",
		"cardStatus": "11",
		"effectStartTime": 1733021696000,
		"expireTime": 1735613696000,
		"bindSuccessTime": 0,
		"lastUseTime": 0,
		"cardId": "",
		"cardName": "",
		"cardFaceValue": 0,
		"cardNetValue": 0,
		"cardBalance": 150,
		"extraInfo": ""
	},
	"traceNo": "TEST16876718849999000003",
	"transDate": "20230625134444"
}
```