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

# 命令

> UQPAY CLI 全部命令参考，包含业务域资源、数据操作与快捷别名。

## 命令结构

所有命令遵循统一结构：

```bash theme={null}
uqpay <domain> <resource> <action> [flags]
```

## 业务域

| 业务域        | 资源                        |
| ---------- | ------------------------- |
| `banking`  | 余额、转账、充值、出款、受益人、换汇、虚拟账户   |
| `issuing`  | 卡片、持卡人、交易、消费控制、报表         |
| `payment`  | Intent、Attempt、退款、结算、银行账户 |
| `connect`  | Connected 账户、子账户入驻、KYC 上传 |
| `simulate` | 沙盒测试——充值、授权、冲正            |
| `file`     | 文档上传与下载链接                 |

## 快捷别名

常用资源有顶层快捷方式，可以跳过业务域名：

| 别名                       | 等价写法                             |
| ------------------------ | -------------------------------- |
| `uqpay beneficiary list` | `uqpay banking beneficiary list` |
| `uqpay card list`        | `uqpay issuing card list`        |
| `uqpay payout list`      | `uqpay banking payout list`      |

## 读操作

通过 flag 传入查询参数：

```bash theme={null}
uqpay banking beneficiary list --page-num 2 --page-size 20
```

## 写操作

使用 `-d key=value` 传入请求体字段。点号记法可以构造嵌套对象：

```bash theme={null}
uqpay banking beneficiary create \
  -d entity_type=INDIVIDUAL \
  -d first_name=John \
  -d bank_details.swift_code=DBSSSGSG
```

<Tip>
  字段默认以字符串类型传入，CLI 会按 API spec 自动转换数值类型。可以直接写 `-d amount=100`，无需声明类型。
</Tip>

## 文件编码

### Base64 编码

在文件路径前加 `@` 前缀，将本地文件 base64 编码后上传：

```bash theme={null}
-d identity.front_file=@./passport.jpg
```

### Data URI 格式

Connect 文档上传使用 `@+` 前缀，将文件编码为 data URI：

```bash theme={null}
-d "certification[0]=@+./cert.png"
```