> ## 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]
>
> * 數據保留 60 天，每次搜尋時間區間小於等於 15 分鐘。

## 請求路徑

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

## 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>渠道編號 (帶入0代表查詢全部渠道)</td></tr>
    <tr><td>`startTime`</td><td>string</td><td>是</td><td>✓</td><td>開始時間 (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</td></tr>
    <tr><td>`endTime`</td><td>string</td><td>是</td><td>✓</td><td>結束時間 (時區、格式請參考[API注意事項](https://doc.va777.net/zh-Hant/v2/guides/request-format.md#時間格式))</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.withdrawList`</td><td>object\[]</td><td>提領列表</td></tr>
    <tr><td>`data.withdrawList[].eventID`</td><td>string</td><td>活動編號</td></tr>
    <tr><td>`data.withdrawList[].grantID`</td><td>string</td><td>派發卡編號</td></tr>
    <tr><td>`data.withdrawList[].trsID`</td><td>string</td><td>派彩錢包異動編號 (唯一)</td></tr>
    <tr><td>`data.withdrawList[].channelID`</td><td>number</td><td>渠道編號</td></tr>
    <tr><td>`data.withdrawList[].account`</td><td>string</td><td>會員帳號</td></tr>
    <tr><td>`data.withdrawList[].currency`</td><td>string</td><td>幣別(請洽詢我方商務)</td></tr>
    <tr><td>`data.withdrawList[].triggerRecordID`</td><td>string</td><td>觸發此派彩的下注紀錄編號；triggerType=EXPIRE\_SETTLE時為空</td></tr>
    <tr><td>`data.withdrawList[].triggerType`</td><td>string</td><td>觸發類型 (PER\_SPIN / FINAL\_SETTLE / EXPIRE\_SETTLE)</td></tr>
    <tr><td>`data.withdrawList[].before`</td><td>number</td><td>派彩前玩家餘額</td></tr>
    <tr><td>`data.withdrawList[].withdrawalAmount`</td><td>number</td><td>派彩金額</td></tr>
    <tr><td>`data.withdrawList[].after`</td><td>number</td><td>派彩後玩家餘額</td></tr>
    <tr><td>`data.withdrawList[].settledAt`</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": {
    "withdrawList": [
      {
        "eventID": "abccc1234567890aaaaa1254",
        "grantID": "abcaa1234567890aaaaa3333",
        "trsID": "test1231231",
        "channelID": 1,
        "account": "test123",
        "currency": "CNY",
        "triggerRecordID": "efr34123",
        "triggerType": "PER_SPIN",
        "before": 23.59,
        "withdrawalAmount": 1,
        "after": 24.59,
        "settledAt": "2022-07-01T10:13:54.920+08:00"
      }
    ],
    "nextToken": "gdfv5451gg5574fs",
    "maxResults": 2000,
    "total": 2000
  },
  "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 還可能回傳：

| 代碼 | 說明 |
| - | - |
| `429` | 呼叫過於頻繁 |


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