# 码作废（退款）接口

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

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

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

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

#### **action**

- `CodeStatusUpdate`

**请求参数，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-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>