> ## 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.

# 获取虚拟账户列表

> 分页获取商户在所有支持的法币下的虚拟子账户及其银行账户信息。

使用此接口列出为某个商户创建的虚拟账户。每条记录都包含虚拟账户的别名、支付方式名称，以及为其充值所需的具体银行账户信息（例如 CLABE 号码、CVU 或 Pix 二维码）。此接口是创建虚拟账户接口对应的查询接口，并支持分页，适用于拥有大量虚拟账户的商户。

> [!NOTE]
>
> 所有请求都必须在 `X-BH-TOKEN` 请求头中携带通过 `GET /v2/token/generate` 获取的业务 token。

## 接口地址

`GET https://api.velafi.com/v2/merchant/virtual/addfunds`

## 查询参数

**merchantId** `integer` *required*

商户 ID。

**paymentId** `integer` *required*

支付通道 ID。支持的取值：

* `105` — SPEI (Finco Pay)，MXN
* `72` — SPEI (Tesored)，MXN
* `63` — CBU/CVU (Momentum)，ARS
* `137` — QR Argentina，ARS（静态二维码）
* `68` — Automatic ACH（支付链接），COP
* `69` — Bre-B，COP（仅在商户的 Bre-B key 创建后）
* `90` — Pix (Genial)，BRL
* `92` — Pix - Woovi (Avenia)，BRL（静态二维码）

**fiat** `string` *required*

法币币种。支持的取值：`MXN`、`ARS`、`COP`、`BRL`。

**depositAlias** `string`

按指定的虚拟账户别名筛选。

**currentPage** `integer`

要获取的页码（从 1 开始）。默认为 `1`。

**pageSize** `integer`

每页记录数。默认为 `10`。超过 `100` 的值会被限制为 `100`；超过 `1000` 的值会被拒绝。

## 响应字段

**code** `number`

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

**msg** `string`

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

**data** `object`

**data 字段**

**currentPage** `number`

返回的当前页码。

**size** `number`

本页的记录数。

**total** `number`

符合查询条件的虚拟账户总数。

**record** `array`

**record 条目字段**

**fiat** `string`

虚拟账户的法币币种。

**depositAlias** `string`

该虚拟账户的别名标识。

**paymentMethodName** `string`

可读的支付方式名称。

**status** `number`

状态：`1` = 认证中，`2` = 正常（已启用），`3` = 认证失败。

**fieldList** `object`

银行账户信息字段名到值的映射。键与[获取待处理资金账户](https://docs.velafi.com/cn/api-reference/merchant/get-pending-fund-account.md)中的相同。本接口不接受 `amount`，因此不会返回针对特定金额的二维码或 `txId`。

## 示例

> [tab] MXN
>
> ```bash cURL theme={null}
> curl -G https://api.velafi.com/v2/merchant/virtual/addfunds \
>   -H "X-BH-TOKEN: YOUR_TOKEN" \
>   --data-urlencode "merchantId=151209" \
>   --data-urlencode "fiat=MXN" \
>   --data-urlencode "paymentId=105"
> ```
>
> ```json Response theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "currentPage": 1,
>     "size": 10,
>     "total": 50,
>     "record": [
>       {
>         "fiat": "MXN",
>         "depositAlias": "store001",
>         "paymentMethodName": "SPEI - FINCO PAY",
>         "fieldList": {
>           "Cuenta CLABE": "000000000000000001"
>         }
>       }
>     ]
>   }
> }
> ```

> [tab] ARS
>
> ```json Response theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "currentPage": 1,
>     "size": 10,
>     "total": 5,
>     "record": [
>       {
>         "fiat": "ARS",
>         "depositAlias": "arg-store",
>         "paymentMethodName": "Automated Bank Transfer (Argentina)",
>         "fieldList": {
>           "CVU Number": "0000000000000000000003",
>           "CUIT": "20000000002"
>         }
>       }
>     ]
>   }
> }
> ```

> [tab] BRL (Pix)
>
> ```json Response theme={null}
> {
>   "code": 200,
>   "msg": "SUCCESS",
>   "data": {
>     "currentPage": 1,
>     "size": 10,
>     "total": 3,
>     "record": [
>       {
>         "fiat": "BRL",
>         "depositAlias": "brl-main",
>         "paymentMethodName": "Automated Pix",
>         "fieldList": {
>           "Pix copia e cola": "00020101021126580014br.gov.bcb.pix013865755...",
>           "Pix QR Code": "https://example.com/pix-qr-code.png"
>         }
>       }
>     ]
>   }
> }
> ```


## Related topics

- [获取商户账户列表](https://docs.velafi.com/cn/api-reference/merchant/get-a-list-of-merchant-accounts.md)
- [更新日志](https://docs.velafi.com/cn/docs/changelog.md)
- [商户](https://docs.velafi.com/cn/docs/merchants.md)
- [创建虚拟账户](https://docs.velafi.com/cn/api-reference/merchant/create-multiple-virtual-account.md)
- [获取商户列表](https://docs.velafi.com/cn/api-reference/merchant/get-a-list-of-merchants.md)


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