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

# 編輯消費帳戶

# 概述

每個現金餘額帳戶都有自己的暱稱，讓使用者在擁有多個帳戶時能輕鬆加以區分。

# 編輯使用者現金餘額帳戶

## 範例請求

你可以使用 `updateUserCashBalance` mutation 來更新使用者的現金餘額帳戶。此 mutation 允許你編輯消費帳戶的暱稱，以協助整理你的資金。該查詢需要一個 `UpdateUserCashBalanceInput` 輸入物件。

```json theme={null}
mutation updateUserCashBalance($input: UpdateUserCashBalanceInput!) {
    updateUserCashBalance(input: $input) {
        userCashBalanceId
        totalCashBalance
        availableCashBalance
        lifetimeCashBalance
        nickname
        status
        createdAt
    }
}
```

此 mutation 需要 `UpdateUserCashBalanceInput` 輸入型別。任何在結構中以驚嘆號（`!`）標示的欄位都是必填，且必須包含在請求中。

| 欄位名稱              | 型別      | 說明                                             |
| :---------------- | :------ | :--------------------------------------------- |
| userCashBalanceId | UUID!   | 現金餘額帳戶的唯一識別碼。                                  |
| nickname          | String! | 現金餘額帳戶的自訂名稱，有助於識別帳戶用途。必須至少 2 個字元，且不超過 100 個字元。 |

## UpdateUserCashBalanceInput

```json theme={null}
{
  "userCashBalanceId": "f8a3c9e1-7b2d-4f5e-9c8a-1d2e3f4g5h6i",
  "nickname": "New Team Travel"
}
```

## 範例回應

`updateUserCashBalance` mutation 的回應將包含新更新的現金餘額帳戶詳細資訊，包括其唯一識別碼與初始餘額資訊。

```json theme={null}
{
  "data": {
    "updateUserCashBalance": {
      "userCashBalanceId": "f8a3c9e1-7b2d-4f5e-9c8a-1d2e3f4g5h6i",
      "totalCashBalance": "0",
      "availableCashBalance": "0",
      "lifetimeCashBalance": "0",
      "nickname": "New Team Travel",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  }
}
```

### 回應欄位

| 欄位名稱                 | 型別                     | 說明                                |
| :------------------- | :--------------------- | :-------------------------------- |
| userCashBalanceId    | UUID!                  | 現金餘額帳戶的唯一識別碼                      |
| totalCashBalance     | String!                | 帳戶中的總現金餘額（起始為 0）                  |
| availableCashBalance | String!                | 可立即使用的現金餘額（起始為 0）                 |
| lifetimeCashBalance  | String!                | 歷來存入資金的累計總額（起始為 0）                |
| nickname             | String                 | 指派給帳戶的自訂名稱                        |
| status               | UserCashBalanceStatus! | 帳戶目前狀態（ACTIVE、CLOSED 或 SUSPENDED） |
| createdAt            | DateTime!              | 帳戶建立的時間戳記                         |

> ❗️ 需要授權
>
> 此 mutation 需要 `MANAGE_PAYMENT` 權限範圍。請在嘗試建立現金餘額帳戶之前，確保你的 access token 已被授予此範圍。