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

# 获取加密资产余额

> 获取指定商户的加密货币钱包余额，或获取与你的 API key 关联的所有商户的汇总余额。

使用此接口查询商户托管钱包中持有的加密资产余额。传入指定的 `merchantId` 可将结果限定为单个商户，传入 `0` 则返回与你的 API key 关联的所有商户的汇总余额。每个资产条目显示总余额、可用（free）部分以及锁定金额（为待处理订单预留）。

> [!NOTE]
>
> 所有请求都必须包含 `X-BH-TOKEN` 请求头，其值为通过 `GET /v2/token/generate` 获取的业务令牌。

## 接口地址

`GET https://api.velafi.com/v2/assets/account/assets`

## 查询参数

**merchantId** `integer` *required*

要查询的商户 ID。传入 `0` 可汇总与此 API key 关联的所有商户的余额。

## 响应字段

**code** `number`

HTTP 风格的响应码。`200` 表示成功。

**msg** `string`

可读的状态信息，例如 `SUCCESS`。

**data** `object`

**data 字段**

**canDeposit** `boolean`

该账户当前是否可以接收加密货币充值。

**balances** `array`

**余额条目字段**

**asset** `string`

资产代码，例如 `USDT`、`BTC`、`USDC`。

**assetId** `string`

内部资产标识符。

**assetName** `string`

可读的资产显示名称。

**total** `string`

该资产的总余额。

**free** `string`

未被待处理订单预留的可用余额。

**locked** `string`

为未完成或处理中的订单预留的余额。

## 示例

> [tab] 指定商户
>
> ```bash cURL theme={null}
> curl -G https://api.velafi.com/v2/assets/account/assets \
>   -H "X-BH-TOKEN: YOUR_TOKEN" \
>   --data-urlencode "merchantId=12345"
> ```
>
> ```json Response theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "canDeposit": true,
>     "balances": [
>       {
>         "asset": "USDT",
>         "assetId": "USDT",
>         "assetName": "USDT",
>         "total": "1000",
>         "free": "800",
>         "locked": "200"
>       },
>       {
>         "asset": "BTC",
>         "assetId": "BTC",
>         "assetName": "BTC",
>         "total": "0.5",
>         "free": "0.3",
>         "locked": "0.2"
>       }
>     ]
>   }
> }
> ```

> [tab] 汇总（所有商户）
>
> ```bash cURL theme={null}
> curl -G https://api.velafi.com/v2/assets/account/assets \
>   -H "X-BH-TOKEN: YOUR_TOKEN" \
>   --data-urlencode "merchantId=0"
> ```
>
> ```json Response theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "canDeposit": true,
>     "balances": [
>       {
>         "asset": "USDT",
>         "assetId": "USDT",
>         "assetName": "USDT",
>         "total": "5000",
>         "free": "4000",
>         "locked": "1000"
>       },
>       {
>         "asset": "BTC",
>         "assetId": "BTC",
>         "assetName": "BTC",
>         "total": "2",
>         "free": "1.5",
>         "locked": "0.5"
>       }
>     ]
>   }
> }
> ```

> [!NOTE]
>
> 当 `merchantId` 为 `0` 时，API 会汇总绑定到同一账户的所有商户的余额。使用此方式可以获得整体资产视图，而无需逐一遍历各个商户 ID。


## Related topics

- [出金（加密货币兑法币）](https://docs.velafi.com/cn/docs/guides/off-ramp.md)
- [创建出金订单](https://docs.velafi.com/cn/api-reference/order/create-a-crypto-to-fiat-order.md)
- [获取加密货币列表](https://docs.velafi.com/cn/api-reference/basic-configuration/get-list-of-crypto-currencies.md)
- [创建加密货币划转](https://docs.velafi.com/cn/api-reference/merchant/crypto-transfer.md)
- [支持的币种](https://docs.velafi.com/cn/docs/currencies.md)


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