> ## Documentation Index
> Fetch the complete documentation index at: https://doc.va777.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 取得免費旋轉派發卡列表

> 取得免費旋轉派發卡列表 API 的請求參數、回應格式與回應訊息碼。

> [!NOTE]
>
> * 依活動與渠道查詢派發卡，支援會員帳號過濾與分頁。

## 請求路徑

```text theme={null}
GET {host}/vendor/v2.0/freespin/grant
```

## Headers

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="56%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`Authorization`</td><td>string</td><td>是</td><td>驗證令牌，由我方提供</td></tr>
  </tbody>
</table>

## 請求參數

<table>
  <colgroup>
    <col width="27%" />

    <col width="10%" />

    <col width="7%" />

    <col width="11%" />

    <col width="45%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>必填</th><th>參與簽章</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`channelID`</td><td>number</td><td>是</td><td>✓</td><td>渠道編號(若無渠道，請帶入1)</td></tr>
    <tr><td>`eventID`</td><td>string</td><td>是</td><td>✓</td><td>活動編號 (24 碼 hex)</td></tr>
    <tr><td>`memberAccount`</td><td>string</td><td>否</td><td>✓</td><td>會員帳號(允許字元:`a-z A-Z 0-9 _-`)</td></tr>
    <tr><td>`nextToken`</td><td>string</td><td>否</td><td>✓</td><td>查詢憑證 (初次查詢帶入空白，之後應帶入前一次結果的nextToken)</td></tr>
    <tr><td>`maxResults`</td><td>number</td><td>是</td><td>✓</td><td>返回限制筆數 (最小2000筆，最大5000筆)</td></tr>
    <tr><td>`sign`</td><td>string</td><td>是</td><td /><td>簽章，產生方式請參考[簽章規則](https://doc.va777.net/zh-Hant/v2/guides/signature.md)</td></tr>
  </tbody>
</table>

## 回應

成功（HTTP 狀態碼固定為 200，請以 `status.code` 判斷結果）

<table>
  <colgroup>
    <col width="34%" />

    <col width="12%" />

    <col width="54%" />
  </colgroup>

  <thead><tr><th>欄位</th><th>型別</th><th>說明</th></tr></thead>

  <tbody>
    <tr><td>`data`</td><td>object</td><td /></tr>
    <tr><td>`data.grantList`</td><td>object\[]</td><td>派發卡列表</td></tr>
    <tr><td>`data.grantList[].eventID`</td><td>string</td><td>活動編號</td></tr>
    <tr><td>`data.grantList[].grantID`</td><td>string</td><td>派發卡編號</td></tr>
    <tr><td>`data.grantList[].channelID`</td><td>number</td><td>渠道編號</td></tr>
    <tr><td>`data.grantList[].memberAccount`</td><td>string</td><td>會員帳號</td></tr>
    <tr><td>`data.grantList[].status`</td><td>string</td><td>狀態 (New / Active / Completed / Freeze / Expired / SettleFailed)</td></tr>
    <tr><td>`data.grantList[].totalSpinTimes`</td><td>number</td><td>派發時贈送的免費旋轉次數</td></tr>
    <tr><td>`data.grantList[].usedSpinTimes`</td><td>number</td><td>已使用次數</td></tr>
    <tr><td>`data.grantList[].paidAmount`</td><td>number</td><td>已實際入錢包的派彩總額</td></tr>
    <tr><td>`data.grantList[].paidCount`</td><td>number</td><td>已派彩次數</td></tr>
    <tr><td>`data.grantList[].grantedAt`</td><td>string</td><td>派發卡建立時間 (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.grantList[].completedAt`</td><td>string</td><td>活動完成時間(未觸發為空) (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.grantList[].frozenAt`</td><td>string</td><td>凍結時間(未觸發為空) (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.grantList[].expiredAt`</td><td>string</td><td>到期時間 (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`data.nextToken`</td><td>string</td><td>下次查詢憑證(最後一次查詢返回空字串)</td></tr>
    <tr><td>`data.maxResults`</td><td>number</td><td>返回限制筆數</td></tr>
    <tr><td>`data.total`</td><td>number</td><td>本次查詢總筆數</td></tr>
    <tr><td>`status`</td><td>object</td><td>回應狀態，請參考[回應格式](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#回應格式)</td></tr>
  </tbody>
</table>

### 回應範例

```json theme={null}
{
  "data": {
    "grantList": [
      {
        "eventID": "qwertyuiop1234569876541",
        "grantID": "zaqwsxcder1234569879999",
        "channelID": 1,
        "memberAccount": "test123",
        "status": "Active",
        "totalSpinTimes": 50,
        "usedSpinTimes": 48,
        "paidAmount": 12.34,
        "paidCount": 45,
        "grantedAt": "2022-07-01T10:13:54.920+08:00",
        "completedAt": null,
        "frozenAt": null,
        "expiredAt": null
      }
    ],
    "nextToken": "gdfv5451gg5574fs",
    "maxResults": 2000,
    "total": 1
  },
  "status": {
    "code": "0",
    "message": "success",
    "datetime": "2022-07-01T10:13:54.920+08:00",
    "traceCode": "7cf25e1957cc47fe8e01f1a7c6d504d6"
  }
}
```

## 回應訊息碼

除了[共通訊息碼](https://doc.va777.net/zh-Hant/v2/reference/response-codes.md)，此 API 還可能回傳：

| 代碼 | 說明 |
| - | - |
| `416` | 查無此活動 |
| `429` | 呼叫過於頻繁 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.