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

# API文档

# 2026/03/06

| 日期         | 更新内容                                                                                     | 版本号    |
| :--------- | :--------------------------------------------------------------------------------------- | :----- |
| 2025/05/08 | 初始版本                                                                                     | V0.1.0 |
| 2025/06/11 | WalletList 接口增加 companyCode 和 walletType 请求参数                                            | V0.1.1 |
| 2025/07/31 | 修改 PayoutModel 参数从 symbol、side 改为 fromAmount、toAmount 方式并合并 AgentModel；收款方信息新增 BankId 参数 | V0.1.2 |
| 2025/08/18 | 收款方去掉 paymentWay                                                                         | V0.1.3 |
| 2025/09/26 | 新增 SOL 和 POLY 链                                                                          | V0.1.4 |
| 2025/10/21 | PayoutModel 新增参数 extOrderNo                                                              | V0.1.5 |
| 2026/03/06 | 收款人支持第三方非同名                                                                              | V0.1.6 |

# API Index

| 分类                  | #  | 接口                    | REST 路径                                         |
| ------------------- | -- | --------------------- | ----------------------------------------------- |
| WalletManagementAPI | 1  | 固定收款地址查询              | `POST /api/v1/wallet/receive-address/query`     |
| WalletManagementAPI | 2  | 静态收款地址查询              | `POST /api/v1/wallet/static-address/query`      |
| WalletManagementAPI | 3  | 查询支持币种                | `POST /api/v1/wallet/supported/currencies`      |
| WalletManagementAPI | 4  | 钱包资产查询                | `POST /api/v1/wallet/assets`                    |
| WalletPaymentAPI    | 1  | 钱包转账                  | `POST /api/v1/payment/transfer`                 |
| WalletPaymentAPI    | 2  | 获取签名                  | `POST /api/v1/payment/sign`                     |
| WalletPaymentAPI    | 3  | 添加地址白名单               | `POST /api/v1/payment/address/whitelist/add`    |
| WalletPaymentAPI    | 4  | 校验地址白名单               | `POST /api/v1/payment/address/whitelist/check`  |
| WalletPaymentAPI    | 5  | 删除地址白名单               | `POST /api/v1/payment/address/whitelist/delete` |
| WalletPaymentAPI    | 6  | 申报收款订单                | `POST /api/v1/payment/order/declare`            |
| WalletPaymentAPI    | 7  | 划拨                    | `POST /api/v1/payment/internal-transfer`        |
| WalletPaymentAPI    | 8  | 订单详情                  | `POST /api/v1/payment/order/detail`             |
| WalletPaymentAPI    | 9  | Request Payment订单申报   | `POST /api/v1/payment/order/declare`            |
| WalletPaymentAPI    | 10 | Request Payment订单材料补充 | `POST /api/v1/payment/order/add/materials`      |
| WalletPaymentAPI    | 11 | 费用查询                  | `POST /api/v1/payment/fee/query`                |
| WalletPaymentAPI    | 12 | 提现下单                  | `POST /api/v1/payment/withdraw`                 |
| WalletPaymentAPI    | 13 | 对账单下载                 | `POST /api/v1/payment/reconciliation`           |
| Off-ramp API        | 1  | 询价                    | `POST /api/v1/payout/quote`                     |
| Off-ramp API        | 2  | 下单                    | `POST /api/v1/payout/book`                      |
| Off-ramp API        | 3  | 订单查询                  | `POST /api/v1/payout/enquiry`                   |
| Off-ramp API        | 4  | 重新结算                  | `POST /api/v1/payout/reSettle`                  |
| Off-ramp API        | 5  | 添加收款账号                | `POST /api/v1/wallet/bank_account/add`          |
| Off-ramp API        | 6  | 更新收款账号                | `POST /api/v1/wallet/bank_account/update`       |
| Off-ramp API        | 7  | 删除收款账号                | `POST /api/v1/wallet/bank_account/del`          |
| Off-ramp API        | 8  | 查询收款账号                | `POST /api/v1/wallet/bank_account/get`          |

# WalletManagementAPI

## 1. 固定收款地址查询 (ReceiveAddressQuery)

**接口概述**

查询指定钱包在特定区块链和币种下的收款地址。

**请求参数**

| 参数名      | 类型     | 是否必填 | 描述                     |
| :------- | :----- | :--- | :--------------------- |
| walletId | int64  | 是    | 钱包 ID                  |
| network  | string | 是    | 区块链网络:ETH/TRX/SOL/POLY |
| currency | string | 是    | 币种:USDT/USDC           |

**响应参数**

| 参数名     | 类型                      | 描述                                |
| :------ | :---------------------- | :-------------------------------- |
| code    | int64                   | 响应码,表示请求处理结果,如 1 表示成功,其他值表示不同错误情况 |
| message | string                  | 响应消息,提供详细的处理信息或错误说明               |
| data    | ReceiveAddressQueryData | 收款地址查询数据                          |

**ReceiveAddressQueryData 字段说明**

| 字段名     | 类型     | 描述   |
| :------ | :----- | :--- |
| address | string | 收款地址 |

**请求示例**

```json theme={null}
{
  "walletId":123456789,
  "network":"ETH",
  "currency":"USDT"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "address":"0x123456789abcdef"
  }
}
```

## 2. 静态收款地址查询 (StaticAddressQuery)

**接口概述**

查询指定钱包的 Request Payment 静态收款地址。

**请求参数**

| 参数名      | 类型     | 是否必填 | 描述                                   |
| :------- | :----- | :--- | :----------------------------------- |
| walletId | int64  | 是    | 钱包 ID                                |
| network  | string | 否    | 区块链网络：`ETH` / `TRX` / `SOL` / `POLY` |
| currency | string | 否    | 币种：`USDT` / `USDC`                   |

**响应参数**

| 参数名     | 类型                        | 描述     |
| :------ | :------------------------ | :----- |
| code    | int32                     | 业务码    |
| message | string                    | 业务消息   |
| data    | Array\<StaticAddressData> | 静态地址列表 |

**StaticAddressData字段说明**

| 字段名          | 类型     | 描述                                                                  |
| :----------- | :----- | :------------------------------------------------------------------ |
| walletId     | int64  | 钱包 ID                                                               |
| network      | string | 区块链网络，如 `ETH` / `TRX`                                               |
| currency     | string | 币种，如 `USDT` / `USDC`                                                |
| address      | string | 静态收款地址                                                              |
| qrCodeBase64 | string | 该地址的二维码图片，Base64 编码，含 `data:image/png;base64,` 前缀，可直接放入 `<img src>` |

**请求示例**

```json theme={null}
{
  "walletId": 123456789,
  "network": "ETH",
  "currency": "USDT"
}
```

**响应示例**

```json theme={null}
{
  "code": 1,
  "message": "Success",
  "data": [
    {
      "walletId": 123456789,
      "network": "ETH",
      "currency": "USDT",
      "address": "0x9f8b2c1d4e5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c",
      "qrCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
    }
  ]
}
```

## 3. 查询支持币种 (SupportedCurrenciesQuery)

**接口概述**

按 `walletId + type` 查询该钱包在指定业务类型下支持的币种、可用网络、单笔金额范围与币种精度。调用方可用该接口在创建入金 / 出金订单前做前置校验，避免提交未开通或超出限额的币种组合。

**请求参数**

| 参数名      | 类型     | 是否必填 | 描述                                           |
| :------- | :----- | :--- | :------------------------------------------- |
| walletId | int64  | 是    | 钱包 ID                                        |
| type     | string | 是    | 业务类型 / 限额类型：`4` 入金（deposit），`3` 提币（withdraw） |

**响应参数**

| 参数名     | 类型                                   | 描述                    |
| :------ | :----------------------------------- | :-------------------- |
| code    | int32                                | 业务码                   |
| message | string                               | 业务消息                  |
| data    | Array\<SupportedCurrenciesQueryData> | 支持币种列表；`code = 1` 时返回 |

**SupportedCurrenciesQueryData字段说明**

| 字段名       | 类型             | 说明                                    |
| :-------- | :------------- | :------------------------------------ |
| type      | int32          | 业务类型 / 限额类型，与请求 `type` 对应             |
| currency  | string         | 币种，如 `USDT` / `USDC` / `USD`          |
| minAmount | string         | 单笔最小金额，字符串形式的十进制数                     |
| maxAmount | string         | 单笔最大金额，字符串形式的十进制数                     |
| networks  | Array\<string> | 该币种支持的区块链网络列表，如 `ETH` / `TRX` / `SOL` |
| precision | int32          | 金额精度，小数位数                             |

**请求示例**

```json theme={null}
{
  "walletId": 123456789,
  "type": 4
}
```

**响应示例**

```json theme={null}
{
  "code": 1,
  "message": "Success",
  "data": [
    {
      "type": 4,
      "currency": "USDT",
      "minAmount": "10",
      "maxAmount": "50000",
      "networks": ["ETH", "TRX"],
      "precision": 6
    },
    {
      "type": 4,
      "currency": "USDC",
      "minAmount": "10",
      "maxAmount": "50000",
      "networks": ["ETH", "SOL"],
      "precision": 6
    }
  ]
}
```

## 4. 钱包资产查询 (WalletAssets)

**接口概述**

查询钱包资产信息。

**请求参数**

| 参数名      | 类型    | 是否必填 | 描述    |
| :------- | :---- | :--- | :---- |
| walletId | int64 | 是    | 钱包 ID |

**响应参数**

| 参数名     | 类型              | 描述                               |
| :------ | :-------------- | :------------------------------- |
| code    | int32           | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string          | 响应消息,提供详细的处理信息或错误说明              |
| data    | WalletDetailDto | 钱包详情数据                           |

**WalletDetailDto 字段说明**

| 字段名            | 类型       | 标签       | 描述                   |
| :------------- | :------- | :------- | :------------------- |
| walletId       | int64    |          | 钱包 ID                |
| companyName    | string   |          | 企业名称                 |
| companyNameCn  | string   |          | 中文企业名称               |
| walletStatus   | int32    |          | 钱包状态:<br />1-可用 2-冻结 |
| createTime     | string   |          | 钱包创建时间               |
| walletType     | int32    |          | 钱包类型: 1-主钱包 2-子钱包    |
| assets         | AssetDto | repeated | 托管资产列表               |
| exchangeAssets | AssetDto | repeated | 交易资产列表               |

**AssetDto 字段说明**

| 字段名              | 类型     | 描述                                  |
| :--------------- | :----- | :---------------------------------- |
| network          | string | 区块链网络,资产所属的网络； 交易资产没有此字段； 如:ETH\TRX |
| currency         | string | 资产币种:USDT/USDC                      |
| totalBalance     | string | 总余额                                 |
| availableBalance | string | 可用余额                                |
| lockBalance      | string | 冻结余额                                |

**请求示例**

```json theme={null}
{
  "walletId":1001
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "walletId":123456789,
    "companyName":"RD Tech",
    "companyNameCn":"圆币科技",
    "walletStatus":1,
    "createTime":"2024-05-20T10:00:00Z",
    "walletType":1,
    "assets":[
      {
        "network":"ETH",
        "currency":"USDT",
        "totalBalance":"10.0",
        "availableBalance":"10.0",
        "lockBalance":"0"
      }
    ],
    "exchangeAssets":[
      {
        "currency":"USDT",
        "totalBalance":"10.0",
        "availableBalance":"10.0",
        "lockBalance":"0"
      }
    ]
  }
}
```

# WalletPaymentAPI

## 1. 钱包转账 (WalletTransfer)

**接口概述**

执行平台内钱包与钱包之间资金转账。

**请求参数**

| 参数名            | 类型     | 是否必填 | 描述                        |
| :------------- | :----- | :--- | :------------------------ |
| walletId       | int64  | 是    | 转出钱包的 ID                  |
| targetWalletId | int64  | 是    | 转入钱包的 ID                  |
| currency       | string | 是    | 转账币种:USDT/USDC            |
| network        | string | 是    | 转账币种所在网络:ETH/TRX/SOL/POLY |
| amount         | string | 是    | 转账金额                      |
| extOrderNo     | string | 是    | 外部订单 ID,唯一                |
| message        | string | 否    | 转账附言                      |

**响应参数**

| 参数名     | 类型                 | 描述                               |
| :------ | :----------------- | :------------------------------- |
| code    | int32              | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string             | 响应消息,表示转账操作的描述或错误信息              |
| data    | WalletTransferData | 转账操作的数据                          |

**WalletTransferData 字段说明**

| 字段名     | 类型     | 描述     |
| :------ | :----- | :----- |
| orderNo | string | RD 订单号 |

**请求示例**

```json theme={null}
{
  "walletId":1001,
  "targetWalletId":1002,
  "currency":"USDT",
  "network":"ETH",
  "amount":"1.0",
  "extOrderNo":"EXT123456789",
  "message":"转账附言"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "orderNo":"ORDER123456789"
  }
}
```

## 2. 获取签名 (GetSignData)

**接口概述**

获取签名。

**请求参数**

| 参数名     | 类型     | 是否必填 | 描述                     |
| :------ | :----- | :--- | :--------------------- |
| network | string | 是    | 区块链网络:ETH/TRX/SOL/POLY |
| address | string | 是    | 要添加白名单的地址              |

**响应参数**

| 参数名     | 类型       | 描述                               |
| :------ | :------- | :------------------------------- |
| code    | int32    | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string   | 响应消息,表示操作的结果或错误信息                |
| data    | SignData | 签名响应数据                           |

**SignData字段说明**

| 字段名        | 类型     | 描述     |
| :--------- | :----- | :----- |
| data       | string | 签名数据   |
| expireTime | int64  | 签名过期时间 |

**请求示例**

```json theme={null}
{
  "network":"ETH",
  "address":"0x123456789abcdef"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"Success",
  "data":
  {
      "data":"93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
      "expireTime":1746755842000
  }
}
```

## 3. 添加地址白名单 (AddAddressWhitelist)

**接口概述**

添加地址到白名单。

**请求参数**

| 参数名           | 类型     | 是否必填 | 描述                         |
| :------------ | :----- | :--- | :------------------------- |
| network       | string | 是    | 区块链网络:ETH/TRX/SOL/POLY     |
| address       | string | 是    | 要添加的地址                     |
| checkType     | int32  | 是    | 检查类型: 1-签名检查 2-交易检查        |
| signData      | string | 条件   | 签名信息,检查类型为签名时必填            |
| signature     | string | 条件   | 签名结果,检查类型为签名时必填            |
| currency      | string | 条件   | 检查类型为交易时必填。收款币种:USDT/USDC  |
| walletId      | int64  | 是    | 收款钱包 ID                    |
| businessType  | int32  | 是    | 业务类型: 1-deposit 2-withdraw |
| addressSource | int32  | 是    | 地址来源类型: 1-个人钱包 2-交易所/托管平台  |
| platformName  | string | 条件   | 所属交易所/托管平台名称,地址来源类型是2时必填   |
| remarks       | string | 否    | 备注                         |

**响应参数**

| 参数名     | 类型              | 描述                               |
| :------ | :-------------- | :------------------------------- |
| code    | int32           | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string          | 响应消息,表示操作的结果或错误信息                |
| data    | WhiteListApiDto | 白名单添加结果                          |

**WhiteListApiDto 字段说明**

| 字段名            | 类型     | 描述                                        |
| :------------- | :----- | :---------------------------------------- |
| id             | int64  | 请求id                                      |
| network        | string | 区块链网络:ETH/TRX/SOL/POLY                    |
| address        | string | 要添加的地址                                    |
| checkType      | int32  | 检查类型: 1-签名检查 2-小额转账检查                     |
| signData       | string | 待签名数据                                     |
| signature      | string | 签名                                        |
| currency       | string | 小额转账的币种:USDT/USDC                         |
| depositAddress | string | 小额转账的收款地址                                 |
| amount         | string | 小额转账需要打款的金额                               |
| status         | string | 状态: SUCCESS、FAIL、PENDING、PENDING\_DEPOSIT |
| expireTime     | int64  | 小额转账打款截止时间                                |
| businessType   | int32  | 业务类型: 1-deposit 2-withdraw                |
| addressSource  | int32  | 地址来源类型: 1-个人钱包 2-交易所/托管平台                 |
| platformName   | string | 所属交易所/托管平台名称                              |
| remarks        | string | 备注                                        |

**请求示例**

签名检查示例：

```json theme={null}
{
  "network": "ETH",
  "address": "0x123456789abcdef",
  "checkType": 1,
  "businessType": 1,
  "walletId": 429883231600640,
  "addressSource": 1,
  "remarks": "this is a remark",
  "signature": "0x1e2bc15251969197f9ceedd8dc327f1ab0c993a7cd0a12794414b62be653cda410b2cd48950ffb7ee3184dcd13ce0674eefde540ce2983a0c9e91c6c4893cea51b",
  "signData": "4553493b-7734-435a-8c93-9ae92e89c99e;1746612121000"
}
```

不做签名检查示例：

```json theme={null}
{
  "network": "ETH",
  "address": "0x123456789abcdef",
  "checkType": 2,
  "businessType": 1,
  "addressSource": 1,
  "remarks": "this is a remark",
  "currency": "USDT",
  "walletId": 429883231600640
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"Success",
    "data":{
        "id":708258726632620032,
        "network":"ETH",
        "address":"0x022a50AE43baC1FBECC160a01a7eb13c64553d7F6",
        "checkType":1,
        "signData":"93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
        "signature":"93fb699d-160e-43a0-b053-817ca4bbdcfd;1746755842000",
        "currency":"",
        "depositAddress":"",
        "amount":"",
        "status":"PENDING",
        "expireTime":0,
        "businessType":1,
        "addressSource":1,
        "platformName":"",
        "remarks":"this is a withdraw remark"
    }
}
```

## 4. 校验地址白名单 (CheckAddressWhitelist)

**接口概述**

检查地址是否在白名单中。

**请求参数**

| 参数名          | 类型     | 是否必填 | 描述                         |
| :----------- | :----- | :--- | :------------------------- |
| address      | string | 是    | 地址,检查该地址是否在白名单中            |
| network      | string | 是    | 区块链网络:ETH/TRX/SOL/POLY     |
| businessType | int32  | 是    | 业务类型: 1-deposit 2-withdraw |

**响应参数**

| 参数名     | 类型                | 描述                               |
| :------ | :---------------- | :------------------------------- |
| code    | int32             | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string            | 响应消息,提供详细的错误信息或状态描述              |
| data    | CheckWhiteListDto | 白名单检查结果                          |

**CheckWhiteListDto 字段说明**

| 字段名          | 类型     | 描述                                                        |
| :----------- | :----- | :-------------------------------------------------------- |
| status       | string | 状态:<br />SUCCESS、FAIL、PENDING、PENDING\_DEPOSIT、NOT\_EXIST |
| businessType | int32  | 业务类型: 1-deposit 2-withdraw                                |
| remarks      | string | 备注                                                        |

**请求示例**

```json theme={null}
{
  "network":"ETH",
  "address":"0x123456789abcdef",
  "businessType":1
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":
  {
    "businessType":1,
    "status ":"SUCCESS",
    "remarks":"deposit白名单"
  }
}
```

## 5. 删除地址白名单 (DeleteAddressWhitelist)

**接口概述**

删除地址白名单。

**请求参数**

| 参数名          | 类型     | 是否必填 | 描述                         |
| :----------- | :----- | :--- | :------------------------- |
| network      | string | 是    | 区块链网络:ETH/TRX/SOL/POLY     |
| address      | string | 是    | 要删除的地址白名单                  |
| businessType | int32  | 是    | 业务类型: 1-deposit 2-withdraw |

**响应参数**

| 参数名     | 类型     | 描述                               |
| :------ | :----- | :------------------------------- |
| code    | int32  | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string | 响应消息,表示操作的结果或错误信息                |

**请求示例**

```json theme={null}
{
  "network":"ETH",
  "address":"0x123456789abcdef",
  "businessType":1
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success"
}
```

## 6. 申报收款订单 (DeclareReceiveOrder)

**接口概述**

申报收款订单。

**请求参数**

| 参数名              | 类型     | 是否必填 | 描述                     |
| :--------------- | :----- | :--- | :--------------------- |
| senderAddress    | string | 是    | 支付方地址                  |
| recipientAddress | string | 是    | 收款方地址                  |
| amount           | string | 是    | 金额,表示存款金额              |
| network          | string | 是    | 区块链网络:ETH/TRX/SOL/POLY |
| currency         | string | 是    | 币种 :USDT/USDC          |
| extOrderNo       | string | 是    | 外部订单 ID,全局唯一           |

**响应参数**

| 参数名     | 类型                 | 描述                               |
| :------ | :----------------- | :------------------------------- |
| code    | int32              | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string             | 响应消息,表示操作的结果或错误信息                |
| data    | WalletTransferData |                                  |

**请求示例**

```json theme={null}
{
  "senderAddress":"0x123456789abcdef",
  "recipientAddress":"0x987654321fedcba",
  "amount":"1000.0",
  "network":"ETH",
  "currency":"USDT",
  "extOrderNo":"EXT123456789"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success"
}
```

## 7. 划拨 (InternalTransfer)

**接口概述**

执行内部划拨操作。

**请求参数**

| 参数名                  | 类型     | 是否必填 | 描述                                 |
| :------------------- | :----- | :--- | :--------------------------------- |
| walletId             | int64  | 是    | 钱包 ID                              |
| internalTransferType | int32  | 是    | 内部划拨类型: 1-托管资产往交易资产划转              |
| network              | string | 条件   | 来源资产的网络:ETH/TRX/SOL/POLY,划拨类型为1时必填 |
| currency             | string | 是    | 币种:USDT/USDC                       |
| amount               | string | 是    | 金额                                 |
| extOrderNo           | string | 是    | 外部订单 ID,用于唯一标识划拨请求                 |

**响应参数**

| 参数名     | 类型                   | 描述                               |
| :------ | :------------------- | :------------------------------- |
| code    | int32                | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string               | 响应消息,提供详细的处理信息或错误说明              |
| data    | InternalTransferData | 内部划拨操作的数据                        |

**InternalTransferData 字段说明**

| 字段名     | 类型     | 描述    |
| :------ | :----- | :---- |
| orderNo | string | 划拨订单号 |

**请求示例**

```json theme={null}
{
  "walletId":1001,
  "internalTransferType":1,
  "network":"ETH",
  "currency":"USDT",
  "amount":"1.0",
  "extOrderNo":"EXT123456789"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "orderNo":"ORDER123456789"
  }
}
```

## 8. 订单详情 (WalletOrderDetail)

**接口概述**

查询钱包订单详情。

**请求参数**

| 参数名        | 类型     | 是否必填 | 描述                                       |
| :--------- | :----- | :--- | :--------------------------------------- |
| walletId   | int64  | 是    | 钱包 ID                                    |
| orderNo    | string | 条件   | 订单号 orderNo/extOrderNo 二者必填一             |
| extOrderNo | string | 条件   | 外部订单号,用于查询订单详情  orderNo/extOrderNo 二者必填一 |

**响应参数**

| 参数名     | 类型                    | 描述                               |
| :------ | :-------------------- | :------------------------------- |
| code    | int32                 | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string                | 响应消息,提供详细的错误信息或处理结果描述            |
| data    | WalletOrderDetailData | 订单详情数据                           |

**WalletOrderDetailData 字段说明**

| 字段名         | 类型     | 描述            |
| :---------- | :----- | :------------ |
| orderNo     | string | 订单号           |
| extOrderNo  | string | 外部订单号         |
| orderType   | string | 订单类型          |
| orderStatus | string | 见附录：入金订单状态    |
| fromAddress | string | 发起方地址         |
| fromWallet  | string | 来源钱包          |
| toAddress   | string | 接收方地址         |
| toWallet    | string | 目标钱包          |
| amount      | string | 金额            |
| network     | string | 区块链网络：ETH、TRX |
| currency    | string | 币种：USDT、USDC  |
| expireTime  | int64  | 订单过期时间        |
| createTime  | int64  | 订单创建时间        |

**请求示例**

```json theme={null}
{
  "orderNo":"ORDER123456789"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success",
    "data":{
        "orderNo":"447767487604736",
        "extOrderNo":"1744341998597",
        "orderType":"PayIn",
        "orderStatus":"SUCCESSFUL",
        "fromAddress":"0x213F2B229BE4f3FFF88fc874a986b19D79623339",
        "toAddress":"0xc496E20b19F009543E49b8512CB990ceb0a230F0",
        "toWallet":"429883231600640",
        "amount":"17",
        "network":"ETH",
        "currency":1744342001561,
        "expireTime":1744342629783,
        "createTime":1744343297296
    }
}
```

## 9. Request Payment订单申报(RequestPaymentOrderDeclare)

**接口概述**

申报Request Payment入金订单

**请求参数**

| 参数名                   | 类型     | 是否必填 | 描述                             |
| :-------------------- | :----- | :--- | :----------------------------- |
| walletId              | int64  | 是    | 入金钱包 ID                        |
| extOrderNo            | string | 是    | 外部订单 ID，用于唯一标识转账请求             |
| senderAddress         | string | 是    | 付款方钱包地址                        |
| network               | string | 是    | 区块链网络：ETH、TRX                  |
| currency              | string | 是    | 币种：USDT、USDC                   |
| amount                | string | 是    | 申报金额<br />注意:申报金额需要和最终入金金额完全匹配 |
| senderName            | string | 是    | 付款方名称                          |
| countryRegion         | string | 是    | 支付方所在国家/地区 ISO 3166编码：如HKG     |
| contactAddress        | string | 是    | 付款方联系住址                        |
| receiverName          | string | 是    | 收款商户名称                         |
| message               | string | 否    | 附言                             |
| materials             | Array  | 否    | 订单还原材料申报对象集合                   |
| productType           | string | 是    | 商品类型                           |
| productName           | string | 是    | 商品名称                           |
| productPrice          | string | 是    | 商品价格                           |
| productCount          | string | 是    | 商品数量                           |
| productUnit           | string | 是    | 商品单位                           |
| logisticsTrackingName | string | 否    | 物流公司名称                         |
| logisticsTrackingNo   | string | 否    | 物流单号                           |

**响应参数**

| 参数名     | 类型     | 描述                |
| :------ | :----- | :---------------- |
| code    | int32  | 响应码,表示请求处理的结果     |
| message | string | 响应消息,表示操作的结果或错误信息 |

**请求示例**

```json theme={null}
{
	"walletId":"429883231600640",
	"extOrderNo":"1747626211614",
	"senderAddress":"0x213F2B229BE4f3FFF88fc874a986b19D79623339",
	"network":"ETH",
	"currency":"USDC",
	"senderName":"Reflective Method Invocation",
	"countryRegion":"HKG",
	"contactAddress":"contact address hong kong",
	"receiverName":"Reflective Method Invocation",
	"message":"request payment msg",
	"materials":[{
		"productType":"Electronics",
		"productName":"Wireless Bluetooth Headphones",
		"productPrice":"89.99",
		"productCount":"150",
		"productUnit":"pcs",
		"logisticsTrackingName":"FedEx International Priority",
		"logisticsTrackingNo":"FX123456789US"
	}],
	"amount":"150"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success"
}
```

## 10. Request Payment订单材料补充(AddRequestPaymentMaterials)

**接口概述**

申报订单补充商品信息等材料

**请求参数**

| 参数名                   | 类型     | 是否必填 | 描述           |
| :-------------------- | :----- | :--- | :----------- |
| walletId              | int64  | 是    | 入金钱包 ID      |
| orderNo               | string | 是    | 订单 ID        |
| materials             | Array  | 否    | 订单还原材料申报对象集合 |
| productType           | string | 是    | 商品类型         |
| productName           | string | 是    | 商品名称         |
| productPrice          | string | 是    | 商品价格         |
| productCount          | string | 是    | 商品数量         |
| productUnit           | string | 是    | 商品单位         |
| logisticsTrackingName | string | 否    | 物流公司名称       |
| logisticsTrackingNo   | string | 否    | 物流单号         |

**响应参数**

| 参数名     | 类型     | 描述                |
| :------ | :----- | :---------------- |
| code    | int32  | 响应码，表示请求处理的结果     |
| message | string | 响应消息，表示操作的结果或错误信息 |

**请求示例**

```json theme={null}
{
  "walletId":"429883231600640",
  "orderNo":"447767487604736",
  "materials":[{
		"productType":"Electronics",
		"productName":"Wireless Bluetooth Headphones",
		"productPrice":"89.99",
		"productCount":"150",
		"productUnit":"pcs",
		"logisticsTrackingName":"FedEx International Priority",
		"logisticsTrackingNo":"FX123456789US"
	}]
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success"
}
```

## 11. 费用查询(feeQuery)

**接口概述**

费用查询接口,查询交易所需的手续费。

**请求参数**

| 参数名       | 类型     | 是否必填 | 描述            |
| :-------- | :----- | :--- | :------------ |
| orderType | int32  | 是    | 见附录：订单类型      |
| walletId  | int64  | 是    | 钱包 ID         |
| network   | string | 是    | 区块链网络：ETH、TRX |
| currency  | string | 是    | 币种：USDT、USDC  |
| payAmount | string | 是    | 下单金额          |

**响应参数**

| 参数名     | 类型     | 描述                               |
| :------ | :----- | :------------------------------- |
| code    | int32  | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string | 响应消息，表示操作的结果或错误信息                |
| data    | 费用详情   |                                  |

**费用详情字段说明**

| 字段名           | 类型     | 描述            |
| :------------ | :----- | :------------ |
| walletId      | int64  | 钱包ID          |
| network       | string | 区块链网络：ETH、TRX |
| currency      | string | 币种：USDT、USDC  |
| payAmount     | string | 下单金额          |
| feeAmount     | string | 手续费           |
| receiveAmount | string | 收款金额          |

**请求示例**

```json theme={null}
{
  "walletId":"429883231600640",
  "network":"ETH",
  "currency":"USDC",
  "payAmount":"666.66"
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "walletId":"429883231600640",
    "network":"ETH",
    "currency":"USDC",
    "payAmount":"666.66",
    "feeAmount":"19.9998",
    "receiveAmount":"646.6602"
  }
}
```

## 12. 提现下单(withdraw)

**接口概述**

创建提现订单

**请求参数**

| 参数名              | 类型     | 是否必填 | 描述                     |
| :--------------- | :----- | :--- | :--------------------- |
| walletId         | int64  | 是    | 钱包 ID                  |
| extOrderNo       | string | 是    | 外部订单 ID，用于唯一标识转账请求     |
| network          | string | 是    | 区块链网络：ETH/TRX/SOL/POLY |
| currency         | string | 是    | 币种：USDT 、USDC          |
| payAmount        | string | 是    | 下单金额，最大支持6位小数          |
| recipientAddress | string | 是    | 收款方区块地址                |
| recipientName    | string | 是    | 收款方名称                  |
| message          | string | 否    | 备注                     |

**响应参数**

| 参数名     | 类型     | 描述                               |
| :------ | :----- | :------------------------------- |
| code    | int32  | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string | 响应消息，表示操作的结果或错误信息                |

**请求示例**

```json theme={null}
{
  "walletId":"429883231600640",
  "extOrderNo":"ext-1745477734002",
  "network":"ETH",
  "currency":"USDC",
  "recipientAddress":"0x213F2B229BE4f3FFF88fc874a111b19D79623339",
  "message":"Message ttt",
  "payAmount":"666.66"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success"
}
```

## 13. 对账单下载(queryReconBill)

**接口概述**

每日上午9点,可提供D-1日对账单下载（备注:文档涉及时间对应时区为香港UTC+8时区）

**请求参数**

| 参数名          | 类型     | 是否必填 | 描述                                                                                                                                                                                         |
| :----------- | :----- | :--- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| walletId     | int64  | 是    | 钱包 ID                                                                                                                                                                                      |
| billDate     | string | 是    | 账单日期，格式：yyyyMMdd                                                                                                                                                                           |
| modeType     | int32  | 是    | 授权模式： 1-直连模式（下载当前钱包的对账单） 2-授权模式（下载当前钱包以及子钱包对账单）                                                                                                                                            |
| accountType  | int32  | 是    | 账户类型： 1-存管账户 2-交易账户                                                                                                                                                                        |
| currencyType | int32  | 是    | 币种类型： 1:ETH-USDT（存管户币种） 2:ETH-USDC（存管户币种） 3:TRX-USDT（存管户币种） 4:USDT（交易账户币种） 5:USDC（交易账户币种） 6:USD(存管账户、交易账户币种) 14:SOL-USDC(存管户币种) 15:SOL-USDT(存管户币种) 16:POLY-USDC(存管户币种) 17:POLY-USDT(存管户币种) |

**响应参数**

| 参数名     | 类型             | 描述                |
| :------ | :------------- | :---------------- |
| code    | int32          | 响应码，表示请求处理的结果     |
| message | string         | 响应消息，表示操作的结果或错误信息 |
| data    | WalletBillData | 对账单信息             |

**WalletBillData字段说明**

| 字段名      | 类型     | 描述          |
| :------- | :----- | :---------- |
| fileName | string | 文件名称        |
| fileUrl  | string | 对账单zip包下载地址 |

**请求示例**

```json theme={null}
{
    "walletId ":123456789,
    "billDate":"20250330",
    "modeType":1,
    "accountType":1,
    "currencyType":1
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"success",
  "data":{
    "fileName":"20231123_123456789_Statement_ETHUSDT.zip",
    "fileUrl":"https://hk-pro-wallet-private-oss.oss-cn-hongkong.aliyuncs.com/thirdpartybilling/1737925914987610112.zip?Expires=1703216183&OSSAccessKeyId=LTAI5tKJmyxrRXQgpGwhhVnK&Signature=8MXwogxJ0NXBZ3FTS6O97%2B%2FpEiQ%3D"
  }
}
```

# ConvertAPI

## PayoutModel

### 1. 询价(payoutQuote)

**接口概述**

用于获取指定币种对的价格及转账相关信息

**请求参数**

| 参数名          | 类型     | 是否必填 | 描述                                                                                                   |
| :----------- | :----- | :--- | :--------------------------------------------------------------------------------------------------- |
| walletId     | int64  | 是    | 钱包 ID                                                                                                |
| fromCurrency | string | 是    | 币种：USDT、USDC                                                                                         |
| fromAmount   | string | 否    | 金额，支持2位小数，fromAmount和toAmount二选一                                                                     |
| toCurrency   | string | 是    | 币种：USD                                                                                               |
| toAmount     | string | 否    | 金额，支持2位小数，fromAmount和toAmount二选一                                                                     |
| paymentWay   | string | 是    | 支付方式：RDT、CHATS                                                                                       |
| feeMode      | int32  | 否    | paymentWay=CHATS 必填<br />手续费扣费模式：<br /> 1-收付双方共同承担（SHAR）<br /> 2-付款方承担所有手续费（OUR) paymentWay=CHATS 必填 |

**响应参数**

| 参数名     | 类型              | 描述                               |
| :------ | :-------------- | :------------------------------- |
| code    | int32           | 响应码,表示请求处理结果,如 1表示成功,其他值表示不同错误情况 |
| message | string          | 响应消息,提供详细的处理信息或错误说明              |
| data    | PayoutQuoteData | 价格及转账相关数据                        |

**PayoutQuoteData 字段说明**

| 字段名             | 类型     | 描述                                                           |
| :-------------- | :----- | :----------------------------------------------------------- |
| walletId        | int64  | 钱包 ID                                                        |
| fromCurrency    | string | 币种：USDT、USDC                                                 |
| fromAmount      | string | 金额                                                           |
| toCurrency      | string | 币种，USD                                                       |
| toAmount        | string | 金额（减去手续费）                                                    |
| paymentWay      | string | 支付方式：RDT、CHATS                                               |
| feeMode         | int32  | 手续费扣费模式，默认值：1<br /> 1-收付双方共同承担（SHAR）<br /> 2-付款方承担所有手续费（OUR) |
| quoteId         | int64  | 询价 ID                                                        |
| price           | string | 价格                                                           |
| priceExpireTime | string | 价格有效截止时间                                                     |
| feeAmount       | string | 手续费                                                          |
| feeCurrency     | string | 手续费币种                                                        |

**请求示例**

```json theme={null}
{
	"walletId":1000232233,
	"fromCurrency":"USDT",
	"fromAmount":"200.12",
	"toCurrency":"USD",
	"paymentWay":"CHATS",
	"feeMode":1
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"Success",
  "data":{
    "walletId":"429405186232384",
    "fromCurrency":"USDT",
	"fromAmount":"200.12",
	"toCurrency":"USD",
    "toAmount":"192.83",
	"paymentWay":"CHATS",
	"feeMode":1,
    "quoteId":"665131773713321985",
    "price":"0.9986",
    "priceExpireTime":"1736387772381",
	"feeAmount":"7",
	"feeCurrency":"USD"
  }
}
```

### 2. 下单(payoutBook)

**接口概述**

基于询价接口返回的 `quoteId` 发起 Payout 下单。

**请求参数**

| 参数名                  | 类型     | 是否必填 | 描述                                          |
| :------------------- | :----- | :--- | :------------------------------------------ |
| walletId             | int64  | 是    | 钱包 ID                                       |
| quoteId              | int64  | 是    | 询价 ID                                       |
| settlementAccountUID | int64  | 是    | 结算账户标识，可通过查询收款账号接口获取                        |
| purpose              | string | 是    | 付款目的，见附录：付款目的                               |
| extOrderNo           | string | 是    | 业务方订单号，只能包含数字、大小写字母、`_`、`-`、`*`，且在同一个商户号下唯一 |

**响应参数**

| 参数名     | 类型             | 描述                 |
| :------ | :------------- | :----------------- |
| code    | int32          | 响应码，表示请求处理结果       |
| message | string         | 响应消息，提供详细处理信息或错误说明 |
| data    | PayoutBookData | Payout 下单结果        |

**PayoutBookData字段说明**

| 字段名                  | 类型     | 描述                                         |
| :------------------- | :----- | :----------------------------------------- |
| walletId             | int64  | 钱包 ID                                      |
| quoteId              | int64  | 询价 ID                                      |
| settlementAccountUID | int64  | 结算账户标识                                     |
| purpose              | string | 付款目的，见附录：付款目的                              |
| orderNo              | string | 订单号                                        |
| fromCurrency         | string | 卖出币种：USDT / USDC                           |
| fromAmount           | string | 卖出金额                                       |
| toCurrency           | string | 买入币种：USD                                   |
| toAmount             | string | 买入金额，已扣除手续费                                |
| paymentWay           | string | 支付方式：RDT / CHATS                           |
| feeMode              | int32  | 手续费扣费模式：1-收付双方共同承担（SHAR）；2-付款方承担所有手续费（OUR） |
| feeAmount            | string | 手续费                                        |
| feeCurrency          | string | 手续费币种                                      |
| orderStatus          | string | 见附录：Payout订单状态                             |
| createTime           | int64  | 订单创建时间                                     |
| extOrderNo           | string | 业务方订单号                                     |

**请求示例**

```json theme={null}
{
  "walletId": 1000232233,
  "quoteId": 665131773713321985,
  "settlementAccountUID": 48775048489845,
  "purpose": "PMT001",
  "extOrderNo": "1234567898"
}
```

**响应示例**

```json theme={null}
{
  "code": 1,
  "message": "Success",
  "data": {
    "walletId": 429405186232384,
    "quoteId": 665205920267108353,
    "settlementAccountUID": 1236547995462114,
    "purpose": "PMT001",
    "orderNo": "431513431160832",
    "fromCurrency": "USDT",
    "fromAmount": "200.12",
    "toCurrency": "USD",
    "toAmount": "192.83",
    "paymentWay": "CHATS",
    "feeMode": 1,
    "feeAmount": "7",
    "feeCurrency": "USD",
    "orderStatus": "SUBMITTED",
    "createTime": 1736405450558,
    "extOrderNo": "1234567898"
  }
}
```

### 3. 订单查询(payoutEnquiry)

**接口概述**

用于查询订单信息

**请求参数**

| 参数名      | 类型     | 是否必填 | 描述                                      |
| :------- | :----- | :--- | :-------------------------------------- |
| walletId | int64  | 是    | 钱包 ID                                   |
| orderNo  | string | 否    | RD系统订单号，orderNo 和 quoteId 最少选择一个        |
| quoteId  | int64  | 否    | 查询价格返回的quoteId，orderNo 和 quoteId 最少选择一个 |

**响应参数**

| 参数名     | 类型         | 描述                               |
| :------ | :--------- | :------------------------------- |
| code    | int32      | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string     | 响应消息，提供详细的处理信息或错误说明              |
| data    | PayoutData | 订单查询数据                           |

**PayoutData 字段说明**

| 字段名                  | 类型     | 描述                                                           |
| :------------------- | :----- | :----------------------------------------------------------- |
| walletId             | int64  | 钱包 ID                                                        |
| quoteId              | int64  | 询价 ID                                                        |
| orderNo              | string | 订单号                                                          |
| fromCurrency         | string | 币种                                                           |
| fromAmount           | string | 金额                                                           |
| toCurrency           | string | 币种                                                           |
| toAmount             | string | 金额                                                           |
| tradeFromAmount      | string | 成交金额                                                         |
| tradeToAmount        | string | 成交金额                                                         |
| price                | string | 下单价格                                                         |
| tradePrice           | string | 成交价格                                                         |
| orderStatus          | string | 见附录：Payout订单状态                                               |
| createTime           | int64  | 订单创建时间                                                       |
| finishTime           | int64  | 订单完成时间                                                       |
| errorMsg             | string | 订单失败原因                                                       |
| settlementAccountUID | int64  | 结算账户标识                                                       |
| purpose              | string | 见附录：付款目的(purpose)                                            |
| paymentWay           | string | 支付方式：RDT/CHATS                                               |
| feeMode              | int32  | 手续费扣费模式，默认值：1<br /> 1-收付双方共同承担（SHAR）<br /> 2-付款方承担所有手续费（OUR) |
| feeAmount            | string | 手续费                                                          |
| feeCurrency          | string | 手续费币种                                                        |
| refundOrderNo        | string | 失败时，退款订单号                                                    |
| refundAmount         | string | 失败时，退款金额                                                     |
| refundCurrency       | string | 失败时，退款币种                                                     |
| extOrderNo           | string | 业务方订单号                                                       |

**请求示例**

```json theme={null}
{
	"walletId":1000232233,
	"quoteId":665131773713321985
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"Success",
  "data":{
     "walletId":1000232233,
	  "quoteId":665131773713321985,
      "orderNo":"442112731049984",
      "fromCurrency":"USDT",
	  "fromAmount":"200.12",
	  "toCurrency":"USD",
      "toAmount":"192.83",
      "tradeFromAmount":"200.12",
      "tradeToAmount":"192.83",
      "price":"1.142",
      "tradePrice":"1.142",
      "orderStatus":"SUCCESSFUL",
      "createTime":1741580889957,
      "finishTime":1741580889957,
      "settlementAccountUID":1236547995462114,
	  "purpose": "PMT001",
      "paymentWay":"CHATS",
	  "feeMode":1,
	  "feeAmount":"7",
	  "feeCurrency":"USD",
      "extOrderNo":"1234567898"
  }
}

```

### 4. 重新结算(payoutReSettle)

**接口概述**

用于结算失败或者结算退款后重新发起结算。

**请求参数**

| 参数名                  | 类型     | 是否必填 | 描述                                                                             |
| :------------------- | :----- | :--- | :----------------------------------------------------------------------------- |
| walletId             | int64  | 是    | 钱包 ID                                                                          |
| orderNo              | string | 是    | Payout 订单号                                                                     |
| refundOrderNo        | string | 是    | 退款订单号                                                                          |
| settlementAccountUID | int64  | 是    | 结算账户标识                                                                         |
| purpose              | string | 是    | 见附录:付款目的(purpose)                                                              |
| remark               | string | 是    | 描述                                                                             |
| paymentWay           | string | 是    | 支付方式:RDT/CHATS                                                                 |
| feeMode              | int32  | 否    | paymentWay=CHATS 必填 手续费扣费模式,默认值：1<br />1-收付双方共同承担（SHAR）<br />2-付款方承担所有手续费（OUR) |

**响应参数**

| 参数名     | 类型                 | 描述                                |
| :------ | :----------------- | :-------------------------------- |
| code    | int32              | 响应码,表示请求处理结果,如 1 表示成功,其他值表示不同错误情况 |
| message | string             | 响应消息,提供详细的处理信息或错误说明               |
| data    | PayoutReSettleData | 下单数据                              |

**PayoutReSettleData 字段说明**

| 字段名                  | 类型     | 描述                                                         |
| :------------------- | :----- | :--------------------------------------------------------- |
| walletId             | int64  | 钱包 ID                                                      |
| orderNo              | string | Payout 订单号                                                 |
| refundOrderNo        | string | 退款订单号                                                      |
| settlementAccountUID | int64  | 结算账户标识                                                     |
| purpose              | string | 见附录：付款目的(purpose)                                          |
| remark               | string | 描述                                                         |
| paymentWay           | string | 支付方式：RDT/CHATS                                             |
| feeMode              | int32  | 手续费扣费模式，默认值：1<br />1-收付双方共同承担（SHAR）<br />2-付款方承担所有手续费（OUR) |
| amount               | string | 重新结算金额                                                     |
| currency             | int64  | 重新结算币种                                                     |
| feeAmount            | string | 手续费                                                        |
| feeCurrency          | string | 手续费币种                                                      |

**请求示例**

```json theme={null}
{
	"walletId":1000232233,
	"orderNo":"442112731049984",
	"refundOrderNo":"232112731049984",
	"settlementAccountUID":1236547995462114,
	"purpose": "PMT001",
	"remark":"remark",
    "paymentWay":"CHATS",
	"feeMode":1
}
```

**响应示例**

```json theme={null}
{
  "code":1,
  "message":"Success",
  "data":{
    "walletId":1000232233,
	"orderNo":"442112731049984",
	"refundOrderNo":"232112731049984",
	"settlementAccountUID":1236547995462114,
	"purpose": "PMT001",
	"remark":"remark",
    "paymentWay":"CHATS",
	"feeMode":1,
    "amount":"183",
	"currency":"USD",
	"feeAmount":"7",
	"feeCurrency":"USD"
  }
}
```

### 5. 添加收款账号(addBankAccount)

**接口概述**

添加收款账号

**请求参数**

| 参数名                   | 类型               | 是否必填 | 描述                                                             |
| :-------------------- | :--------------- | :--- | :------------------------------------------------------------- |
| walletId              | int64            | 是    | 钱包 ID                                                          |
| alias                 | string           | 是    | 别名                                                             |
| accountOwnership      | int32            | 是    | 绑定钱包(walletId )关系: 1-own account 2-other account 3=Third party |
| currency              | string           | 是    | 币种：USD                                                         |
| accountType           | int32            | 是    | 账户类型: 1-RD Wallet 2-Bank Account                               |
| companyName           | string           | 是    | 公司名称 accountOwnership=2，该名称必须和companyCode公司名称一致                |
| accountNumber         | string           | 是    | 账号，RD Wallet Id or Bank Number                                 |
| bankId                | string           | 是    | 香港银行id，例如：003                                                  |
| beneficiaryAddress1   | string           | 否    | 收款方地址1(不允许中文)，accountType=2时必填                                 |
| beneficiaryAddress2   | string           | 否    | 收款方地址2(不允许中文)，accountType=2时必填                                 |
| beneficiaryAddress3   | string           | 否    | 收款方地址3：国家/地区 ISO 3166编码，accountType=2时必填                       |
| beneficiarySwiftCode  | string           | 否    | 银行Swift Code，必须是HK地区，accountType=2时必填                          |
| intermediarySwiftCode | string           | 否    | 中间银行Swift Code，必须是HK地区                                         |
| companyCode           | string           | 否    | 企业编码accountOwnership=2，必填                                      |
| paymentFiles          | Array\<FileInfo> | 否    | 支付证明文件，accountOwnership=3必填                                    |
| remark                | string           | 否    | 备注，accountOwnership=3选填                                        |

**响应参数**

| 参数名     | 类型              | 描述                               |
| :------ | :-------------- | :------------------------------- |
| code    | int32           | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string          | 响应消息，表示操作的结果或错误信息                |
| data    | BankAccountData | 账户信息                             |

**BankAccountData字段说明**

| 参数名                   | 类型               | 描述                                               |
| :-------------------- | :--------------- | :----------------------------------------------- |
| settlementAccountUID  | int64            | 结算账户标识                                           |
| walletId              | int64            | 钱包 ID                                            |
| alias                 | string           | 别名                                               |
| accountOwnership      | int32            | 绑定钱包(walletId )关系： 1-own account 2-other account |
| currency              | string           | 币种:USD                                           |
| accountType           | int32            | 账户类型: 1-RD Wallet 2-Bank Account                 |
| companyName           | string           | 公司名称                                             |
| accountNumber         | string           | 账号, RD Wallet Id or Bank Number                  |
| bankId                | string           | 香港银行id，例如：003                                    |
| beneficiaryAddress1   | string           | 收款方地址1(不允许中文)                                    |
| beneficiaryAddress2   | string           | 收款方地址2(不允许中文)                                    |
| beneficiaryAddress3   | string           | 收款方地址3：国家/地区 ISO 3166编码                          |
| beneficiarySwiftCode  | string           | 银行Swift Code                                     |
| intermediarySwiftCode | string           | 中间银行Swift Code                                   |
| companyCode           | string           | 企业编码                                             |
| status                | int32            | 状态： 0-处理中 1-成功 2-失败                              |
| paymentFiles          | Array\<FileInfo> | 支付证明文件                                           |
| remark                | string           | 备注                                               |

**FileInfo字段说明**

| 参数名      | 类型    | 描述                  |
| :------- | :---- | :------------------ |
| fileKey  | 文件ID  | 调用上传接口后会返回          |
| fileName | 文件名称  |                     |
| fileUrl  | 文件URL | 调用上传接口后会返回，定期会更新URL |

**请求示例**

```json theme={null}
{
    "walletId":4298832316123456,
    "alias":"name alias",
    "accountOwnership":2,
    "currency":"USD",
    "accountType":2,
    "companyName":"narti adiddf",
    "accountNumber":"8888888",
    "bankId":"003",
    "beneficiaryAddress1":"payee address1",
    "beneficiaryAddress2":"payee address2",
    "beneficiaryAddress3":"HK",
    "beneficiarySwiftCode":"DHBKHKHHXXX",
    "intermediarySwiftCode":"DHBKHKHHXXX",
    "companyCode":"HK1239876654",
    "paymentFiles": [
      {
        "fileKey": "file_key_123",
        "fileName": "证明文件.pdf"
      }
    ],
    "remark": "备注信息"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success",
    "data":{
        "settlementAccountUID":1236547995462114,
        "walletId":4298832316123456,
        "alias":"name alias",
        "accountOwnership":2,
        "currency":"USD",
        "accountType":2,
        "companyName":"narti adiddf",
        "accountNumber":"8888888",
        "bankId":"003",
        "beneficiaryAddress1":"payee address1",
        "beneficiaryAddress2":"payee address2",
        "beneficiaryAddress3":"HK",
        "beneficiarySwiftCode":"DHBKHKHHXXX",
        "intermediarySwiftCode":"DHBKHKHHXXX",
        "companyCode":"HK1239876654",
        "status":0,
        "paymentFiles": [
          {
            "fileKey": "file_key_123",
            "fileName": "证明文件.pdf",
            "fileUrl": "https://xxxxx"
          }
        ],
        "remark": "备注信息"
    }
}
```

### 6. 更新收款账号(updateBankAccount)

**接口概述**

更新收款账号

**请求参数**

| 参数名                   | 类型               | 是否必填 | 描述                                      |
| :-------------------- | :--------------- | :--- | :-------------------------------------- |
| walletId              | int64            | 是    | 钱包 ID                                   |
| settlementAccountUID  | int64            | 是    | 结算账户标识                                  |
| alias                 | string           | 否    | 别名                                      |
| accountNumber         | string           | 否    | 账号, RD Wallet Id or Bank account number |
| bankId                | string           | 否    | 香港银行id，例如：003                           |
| beneficiaryAddress1   | string           | 否    | 收款方地址1(不允许中文)                           |
| beneficiaryAddress2   | string           | 否    | 收款方地址2(不允许中文)                           |
| beneficiaryAddress3   | string           | 否    | 收款方地址3：国家/地区 ISO 3166编码                 |
| beneficiarySwiftCode  | string           | 否    | 银行Swift Code，必须是HK地区                    |
| intermediarySwiftCode | string           | 否    | 中间银行Swift Code，必须是HK地区                  |
| paymentFiles          | Array\<FileInfo> | 否    | 支付证明文件，accountOwnership=3必填             |
| remark                | string           | 否    | 备注，accountOwnership=3选填                 |

**响应参数**

| 参数名     | 类型              | 描述                               |
| :------ | :-------------- | :------------------------------- |
| code    | int32           | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string          | 响应消息，表示操作的结果或错误信息                |
| data    | BankAccountData | 账户信息                             |

**BankAccountData字段说明**

| 参数名                   | 类型               | 描述                                               |
| :-------------------- | :--------------- | :----------------------------------------------- |
| settlementAccountUID  | int64            | 结算账户标识                                           |
| walletId              | int64            | 钱包 ID                                            |
| alias                 | string           | 别名                                               |
| accountOwnership      | int32            | 绑定钱包(walletId )关系： 1-own account 2-other account |
| currency              | string           | 币种：USD                                           |
| accountType           | int32            | 账户类型： 1-RD Wallet 2-Bank Account                 |
| companyName           | string           | 公司名称                                             |
| accountNumber         | string           | 账号, RD Wallet Id or Bank account number          |
| bankId                | string           | 香港银行id，例如：003                                    |
| beneficiaryAddress1   | string           | 收款方地址1(不允许中文)                                    |
| beneficiaryAddress2   | string           | 收款方地址2(不允许中文)                                    |
| beneficiaryAddress3   | string           | 收款方地址3：国家/地区 ISO 3166编码                          |
| beneficiarySwiftCode  | string           | 银行Swift Code                                     |
| intermediarySwiftCode | string           | 中间银行Swift Code                                   |
| companyCode           | string           | 企业编码                                             |
| status                | int32            | 状态： 0-处理中 1-成功 2-失败                              |
| paymentFiles          | Array\<FileInfo> | 支付证明文件                                           |
| remark                | string           | 备注                                               |

**请求示例**

```json theme={null}
{
    "settlementAccountUID":1236547995462114,
    "walletId":4298832316123456,
    "alias":"name alias",
    "accountNumber":"8888888",
    "bankId":"003",
    "beneficiaryAddress1":"payee address1",
    "beneficiaryAddress2":"payee address2",
    "beneficiaryAddress3":"HK",
    "beneficiarySwiftCode":"DHBKHKHHXXX",
    "intermediarySwiftCode":"DHBKHKHHXXX",
    "paymentFiles": [
        {
          "fileKey": "file_key_123",
          "fileName": "证明文件.pdf"
        }
      ],
    "remark": "备注信息"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success",
    "data":{
        "settlementAccountUID":1236547995462114,
        "walletId":4298832316123456,
        "alias":"name alias",
        "accountOwnership":2,
        "currency":"USD",
        "accountType":2,
        "companyName":"narti adiddf",
        "accountNumber":"8888888",
        "bankId":"003",
        "beneficiaryAddress1":"payee address1",
        "beneficiaryAddress2":"payee address2",
        "beneficiaryAddress3":"HK",
        "beneficiarySwiftCode":"DHBKHKHHXXX",
        "intermediarySwiftCode":"DHBKHKHHXXX",
        "companyCode":"HK1239876654",
        "status":0,
        "paymentFiles": [
          {
            "fileKey": "file_key_123",
            "fileName": "证明文件.pdf",
            "fileUrl": "https://xxxxx"
          }
        ],
        "remark": "备注信息"
    }
}
```

### 7. 删除收款账号(delBankAccount)

**接口概述**

删除收款账号

**请求参数**

| 参数名                  | 类型     | 是否必填 | 描述     |
| :------------------- | :----- | :--- | :----- |
| walletId             | int64  | 是    | 钱包 ID  |
| settlementAccountUID | int64  | 是    | 结算账户标识 |
| reason               | string | 是    | 删除原因   |

**响应参数**

| 参数名     | 类型     | 描述                               |
| :------ | :----- | :------------------------------- |
| code    | int32  | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string | 响应消息，表示操作的结果或错误信息                |

**请求示例**

```json theme={null}
{
    "settlementAccountUID":1236547995462114,
    "walletId":4298832316123456,
    "reason":"del reason"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success"
}
```

### 8. 查询收款账号(getBankAccount)

**接口概述**

查询收款账号

**请求参数**

| 参数名                  | 类型     | 是否必填 | 描述     |
| :------------------- | :----- | :--- | :----- |
| walletId             | int64  | 是    | 钱包 ID  |
| settlementAccountUID | int64  | 否    | 结算账户标识 |
| companyCode          | string | 否    | 企业编码   |

**响应参数**

| 参数名     | 类型                | 描述                               |
| :------ | :---------------- | :------------------------------- |
| code    | int32             | 响应码，表示请求处理结果，如 1表示成功，其他值表示不同错误情况 |
| message | string            | 响应消息，表示操作的结果或错误信息                |
| data    | BankAccountData集合 | 账户信息                             |

**BankAccountData字段说明**

| 参数名                   | 类型               | 描述                                              |
| :-------------------- | :--------------- | :---------------------------------------------- |
| settlementAccountUID  | int64            | 结算账户标识                                          |
| walletId              | int64            | 钱包 ID                                           |
| alias                 | string           | 别名                                              |
| accountOwnership      | int32            | 绑定钱包(walletId )关系 1-own account 2-other account |
| currency              | string           | 币种：USD                                          |
| accountType           | int32            | 账户类型： 1-RD Wallet 2-Bank Account                |
| companyName           | string           | 公司名称                                            |
| accountNumber         | string           | 账号，RD Wallet Id or Bank Number                  |
| bankId                | string           | 香港银行id，例如：003                                   |
| beneficiaryAddress1   | string           | 收款方地址1(不允许中文)                                   |
| beneficiaryAddress2   | string           | 收款方地址2(不允许中文)                                   |
| beneficiaryAddress3   | string           | 收款方地址3：国家/地区 ISO 3166编码                         |
| beneficiarySwiftCode  | string           | 银行Swift Code                                    |
| intermediarySwiftCode | string           | 中间银行Swift Code                                  |
| companyCode           | string           | 企业编码                                            |
| status                | int32            | 状态： 0-处理中 1-成功 2-失败                             |
| paymentFiles          | Array\<FileInfo> | 支付证明文件                                          |
| remark                | string           | 备注                                              |

**请求示例**

```json theme={null}
{
    "settlementAccountUID":1236547995462114,
    "walletId":4298832316123456,
    "companyCode":"HK1239876654"
}
```

**响应示例**

```json theme={null}
{
    "code":1,
    "message":"success",
    "data":[{
        "settlementAccountUID":1236547995462114,
        "walletId":4298832316123456,
        "alias":"name alias",
        "accountOwnership":2,
        "currency":"USD",
        "accountType":2,
        "companyName":"narti adiddf",
        "accountNumber":"8888888",
        "bankId":"003",
        "beneficiaryAddress1":"payee address1",
        "beneficiaryAddress2":"payee address2",
        "beneficiaryAddress3":"HK",
        "beneficiarySwiftCode":"DHBKHKHHXXX",
        "intermediarySwiftCode":"DHBKHKHHXXX",
        "companyCode":"HK1239876654",
        "status":0,
        "paymentFiles": [
          {
            "fileKey": "file_key_123",
            "fileName": "证明文件.pdf",
            "fileUrl": "https://xxxxx"
          }
        ],
        "remark": "备注信息"
    }]
}
```

# Callback

## 1. Callback请求体 (CallbackRequest)

**接口概述**

回调请求体用于接收服务端回推的业务数据。

**请求参数**

| 参数名               | 类型          | 是否必填 | 描述                     |
| :---------------- | :---------- | :--- | :--------------------- |
| bizType           | OpenBizType | 是    | 业务类型，指定回调的业务类型         |
| data              | bytes       | 是    | 业务二进制数据，回调中的实际业务内容     |
| clientFingerprint | string      | 是    | 客户端证书指纹，用于验证回调请求的客户端身份 |
| serverFingerprint | string      | 是    | 服务器证书指纹，用于验证回调请求的服务器身份 |

**OpenBizType 枚举说明**

| 枚举值                                        | 描述       |
| :----------------------------------------- | :------- |
| \_BIZ\_TYPE\_UNKNOWN                       | 未知的业务类型  |
| ORDER\_RESULT\_NOTIFICATION                | 订单结果通知   |
| WHITELIST\_RESULT\_NOTIFICATION            | 白名单结果通知  |
| EXCHANGE\_BIZ\_TYPE\_NOTIFICATION          | 交易业务类型通知 |
| WALLET\_OPEN\_NOTIFICATION                 | 钱包开户结果通知 |
| COMPANY\_APPLICATION\_RESULT\_NOTIFICATION | 企业申请结果通知 |

**请求示例**

```json theme={null}
{
  "bizType":"ORDER_RESULT_NOTIFICATION",
  "data":"base64_encoded_data",
  "clientFingerprint":"client_fingerprint_value",
  "serverFingerprint":"server_fingerprint_value"
}
```

## 2. 回调数据类型

### 2.1 订单结果通知

**字段说明**

| 字段名         | 类型     | 描述                     |
| :---------- | :----- | :--------------------- |
| orderNo     | string | 订单号                    |
| currency    | string | 币种：USDT/USDC           |
| network     | string | 区块链网络：ETH/TRX/SOL/POLY |
| status      | string | 订单状态                   |
| amount      | string | 金额                     |
| fromAddress | string | 发起方地址                  |
| fromWallet  | string | 来源钱包                   |
| toAddress   | string | 接收方地址                  |
| toWallet    | string | 目标钱包                   |
| txHash      | string | 交易哈希                   |
| orderType   | string | 订单类型                   |
| extOrderNo  | string | 外部订单号                  |

**示例数据**

```json theme={null}
{
  "orderNo":"ORDER123456789",
  "currency":"USDT",
  "network":"ETH",
  "status":"SUCCESS",
  "amount":"1.0",
  "fromAddress":"0x123456789abcdef",
  "toAddress":"0x987654321fedcba",
  "fromWallet":"123456",
  "toWallet":"1234567",
  "txHash":"0x123456789abcdef123456789abcdef",
  "orderType":"TRANSFER",
  "extOrderNo":"EXT123456789"
}
```

### 2.2 白名单结果通知

**字段说明**

| 字段名          | 类型     | 描述                          |
| :----------- | :----- | :-------------------------- |
| network      | string | 区块链网络:ETH/TRX/SOL/POLY      |
| address      | string | 地址                          |
| businessType | int32  | 业务类型: 1-deposit 2-withdraw  |
| status       | string | 状态: true: 成功<br />false: 失败 |

**示例数据**

```json theme={null}
{
  "network":"ETH",
  "address":"0x123456789abcdef",
  "businessType":1,
  "status":"true"
}
```

### 2.3 添加收款账号结果通知

**字段说明**

| 参数名                   | 类型     | 描述                                                  |
| :-------------------- | :----- | :-------------------------------------------------- |
| settlementAccountUID  | int64  | 结算账户标识                                              |
| walletId              | int64  | 钱包 ID                                               |
| alias                 | string | 别名                                                  |
| accountOwnership      | int32  | 和要绑定钱包(walletId )的关系： 1=own account 2=other account |
| currency              | string | 币种：USD                                              |
| accountType           | int32  | 账户类型 ： 1=RD Wallet 2=Bank Account                   |
| accountName           | string | 账户名称                                                |
| accountNumber         | string | 账号，RD Wallet Id or Bank Number                      |
| bankId                | string | 香港银行id，例如：003                                       |
| beneficiaryAddress1   | string | 收款方地址1(不允许中文)                                       |
| beneficiaryAddress2   | string | 收款方地址2(不允许中文)                                       |
| beneficiaryAddress3   | string | 收款方地址3：国家/地区 ISO 3166编码                             |
| beneficiarySwiftCode  | string | 银行Swift Code                                        |
| intermediarySwiftCode | string | 中间银行Swift Code                                      |
| companyCode           | string | 企业编码                                                |
| status                | int32  | 状态： 0-处理中 1-成功 2-失败                                 |

**示例数据**

```json theme={null}
{
  "settlementAccountUID":1236547995462114,
  "walletId":4298832316123456,
  "alias":"name alias",
  "accountOwnership":2,
  "currency":"USD",
  "accountType":2,
  "accountName":"narti adiddf",
  "accountNumber":"8888888",
  "bankId":"003",
  "beneficiaryAddress1":"payee address1",
  "beneficiaryAddress2":"payee address2",
  "beneficiaryAddress3":"HK",
  "beneficiarySwiftCode":"DHBKHKHHXXX",
  "intermediarySwiftCode":"DHBKHKHHXXX",
  "companyCode":"HK1239876654",
  "status":0
}
```

### 2.4 Payout结果通知

**字段说明**

| 字段名                  | 类型     | 描述                                                           |
| :------------------- | :----- | :----------------------------------------------------------- |
| walletId             | int64  | 钱包 ID                                                        |
| quoteId              | int64  | 询价 ID                                                        |
| orderNo              | string | 订单号                                                          |
| fromCurrency         | string | 币种                                                           |
| fromAmount           | string | 金额                                                           |
| toCurrency           | string | 币种                                                           |
| toAmount             | string | 金额                                                           |
| tradeFromAmount      | string | 成交金额                                                         |
| tradeToAmount        | string | 成交金额                                                         |
| price                | string | 下单价格                                                         |
| tradePrice           | string | 成交价格                                                         |
| orderStatus          | string | 见附录:Payout订单状态                                               |
| createTime           | int64  | 订单创建时间                                                       |
| finishTime           | int64  | 订单完成时间                                                       |
| errorMsg             | string | 订单失败原因                                                       |
| settlementAccountUID | int64  | 结算账户标识                                                       |
| purpose              | string | 见附录：付款目的(purpose)                                            |
| paymentWay           | string | 支付方式：RDT/CHATS                                               |
| feeMode              | int32  | 手续费扣费模式，默认值：1<br /> 1-收付双方共同承担（SHAR）<br /> 2-付款方承担所有手续费（OUR) |
| feeAmount            | string | 手续费                                                          |
| feeCurrency          | string | 手续费币种                                                        |
| refundOrderNo        | string | Payout订单状态为SETTLING\_FAILED有值，用于重新发起结算                       |
| extOrderNo           | string | 业务方订单号（只能是数字、大小写字母\_-\*且在同一个商户号下唯一）                          |

**示例数据**

```json theme={null}
{
     "walletId":1000232233,
	  "quoteId":665131773713321985,
      "orderNo":"442112731049984",
      "fromCurrency":"USDT",
	  "fromAmount":"200.12",
	  "toCurrency":"USD",
      "toAmount":"192.83",
      "tradeFromAmount":"200.12",
      "tradeToAmount":"192.83",
      "price":"1.142",
      "tradePrice":"1.142",
      "orderStatus":"SUCCESSFUL",
      "createTime":1741580889957,
      "finishTime":1741580889957,
      "settlementAccountUID":1236547995462114,
	  "purpose": "PMT001",
      "paymentWay":"CHATS",
	  "feeMode":1,
	  "feeAmount":"7",
	  "feeCurrency":"USD",
      "extOrderNo":"1234567898"
}
```

### 2.5 Payout退款结果通知

**字段说明**

| 字段名            | 类型     | 描述         |
| :------------- | :----- | :--------- |
| walletId       | int64  | 钱包 ID      |
| orderNo        | string | Payout 订单号 |
| refundOrderNo  | string | 退款订单号      |
| refundAmount   | string | 实际退款金额     |
| refundCurrency | string | 退款币种       |
| refundReason   | string | 有则回传       |

**示例数据**

```json theme={null}
{
      "walletId":123456789,
      "orderNo":"442112731049984",
      "refundOrderNo":"442112731049984D1",
      "refundAmount":"664.26",
      "refundCurrency":"USD",
      "refundReason":"refund",
      "refundTime":1741580889957
}
```

### 2.6 Payout重新结算结果通知

**字段说明**

| 字段名                  | 类型     | 描述                                                         |                |
| :------------------- | :----- | :--------------------------------------------------------- | :------------- |
| walletId             | int64  | 钱包 ID                                                      |                |
| orderNo              | string | Payout 订单号                                                 |                |
| refundOrderNo        | string | 退款订单号                                                      |                |
| settlementAccountUID | int64  | 结算账户标识                                                     |                |
| purpose              | string | 见附录：付款目的(purpose)                                          |                |
| remark               | string | 描述                                                         |                |
| paymentWay           | string | 支付方式：RDT/CHATS                                             | 支付方式:RDT/CHATS |
| feeMode              | int32  | 手续费扣费模式，默认值：1<br />1:收付双方共同承担（SHAR）<br />2:付款方承担所有手续费（OUR) |                |
| amount               | string | 结算金额                                                       |                |
| currency             | string | 结算币种                                                       |                |
| feeAmount            | string | 手续费                                                        |                |
| feeCurrency          | string | 手续费币种                                                      |                |

**示例数据**

```json theme={null}
{
    "walletId":1000232233,
	"orderNo":"442112731049984",
	"refundOrderNo":"232112731049984",
	"settlementAccountUID":1236547995462114,
	"purpose": "PMT001",
	"remark":"remark",
    "paymentWay":"CHATS",
	"feeMode":1,
    "amount":"183",
	"currency":"USD",
	"feeAmount":"7",
	"feeCurrency":"USD",
    "createTime":1741580889957,
    "finishTime":1741580889957,
    "orderStatus":"SUCCESSFUL"
}
```

# 附录

## **响应码**

| **代码** | **描述**                                      |
| :----- | :------------------------------------------ |
| 1      | 成功                                          |
| 6001   | failed 通用业务失败                               |
| 6002   | parameter error（参数错误）                       |
| 6003   | order not exist (订单不存在)                     |
| 6004   | order duplicate （订单重复）                      |
| 6005   | no permissions（没有权限）                        |
| 6006   | assets not exists（资产不存在）                    |
| 6101   | wallet account not exists（钱包账号不存在）          |
| 6102   | wallet insufficient fund（钱包余额不足）            |
| 6103   | wallet status invalid（钱包账号无效）               |
| 6104   | recipient wallet unavailable （收款钱包不可用）      |
| 6105   | recipient wallet not exists（收款钱包不存在）        |
| 6109   | Daily payment limit exceeded (付款日限额不足)      |
| 6110   | Monthly collection limit exceeded (收款月限额不足) |
| 6301   | provider unavailable（通道不可用）                 |
| 6302   | symbol unavailable（币种对不可用）                  |
| 6303   | provider reject（拒绝）                         |
| 6304   | price expire time（价格已过期）                    |
| 6305   | amount lt min amount（金额小于最低限额）              |
| 6306   | amount gt max amount（金额大于最高限额）              |
| 6307   | outside of hours（不在交易时间内）                   |
| 6401   | address already exists地址已存在                 |
| 6406   | processing (请求正在处理)                         |
| 6801   | duplicate request（重复申请）                     |
| 6802   | profile error（资料错误）                         |
| 6803   | reach the max limit（钱包数量达到上限）               |

## 兑换订单状态

| **代码**     | **描述** |           |
| :--------- | :----- | :-------- |
| SUBMITTED  | 已提交    | 订单已提交     |
| CONVERTING | 兑换中    | 订单兑换中     |
| SETTLING   | 结算中    | 兑换成功,进行结算 |
| SUCCESSFUL | 交易成功   | 订单处理成功    |
| FAILED     | 交易失败   | 订单处理失败    |

## Payout订单状态

| **代码**           | **描述** |           |
| :--------------- | :----- | :-------- |
| SUBMITTED        | 已提交    | 订单已提交     |
| CONVERTING       | 兑换中    | 订单兑换中     |
| SETTLING         | 结算中    | 兑换成功,进行结算 |
| SETTLING\_FAILED | 结算失败   | 兑换成功,结算失败 |
| SETTLING\_REFUND | 退款     | 结算成功后被退款  |
| SUCCESSFUL       | 交易成功   | 订单处理成功    |
| FAILED           | 交易失败   | 订单处理失败    |

## 入金订单状态

| **代码**                  | **描述** |                                  |
| :---------------------- | :----- | :------------------------------- |
| SUBMITTED               | 已提交    | 订单已提交                            |
| VERIFYING               | 订单验证   | 订单提交后,进行安全验证,仅适用于Request Payment |
| AWAIT\_FOR\_RECEIVE     | 等待收款   | 订单创建成功,等待收款,仅适用于Request Payment  |
| PAYMENT\_VERIFYING      | 收款验证中  | 平台已收款,进行安全验证,仅适用于Request Payment |
| AWAIT\_FOR\_DECLARATION | 待补充材料  | 待补充贸易材料,仅适用于Request Payment      |
| DECLARATION\_REVIEW     | 材料验证中  | 材料审核中                            |
| SUCCESS                 | 交易成功   | 订单成功                             |
| FAILED                  | 交易失败   | 订单失败                             |
| CLOSED                  | 交易关闭   | 订单到期后关闭                          |
| RETURNING               | 退款中    | 退款中                              |
| RETURNED                | 已退款    | 退款处理成功                           |
| IN\_PROGRESS            | 收款验证中  | 平台已收款,进行安全验证,仅适用于Deposit         |

## 订单类型

| **代码** | **描述**            |
| :----- | :---------------- |
| 1      | Deposit           |
| 2      | Wallet Transfer   |
| 3      | Internal Transfer |
| 4      | Request Payment   |
| 5      | Withdraw          |

## 字段说明:amount(金额)

该字段用于表示交易金额,类型为字符串,具体精度要求如下:

* **数币（Digital Currency）**:一般支持精确到小数点后最多 **6 位**,用于满足链上交易的精度需求；
* **法币（Fiat Currency）**:通常保留 **最多 2 位小数**,即精确到"分"；
* **日元（JPY）**:由于日元为无小数货币,amount应为整数,**不允许包含小数部分**。

请调用方根据币种类型严格控制金额格式,以避免精度误差或接口处理异常。

## 付款目的

| **目的** | **说明**                                                                                                                                    |
| :----- | :---------------------------------------------------------------------------------------------------------------------------------------- |
| PMT001 | Invoice payments---发票付款                                                                                                                   |
| PMT002 | Payment for services---服务付款                                                                                                               |
| PMT003 | Payment for software---软件付款                                                                                                               |
| PMT004 | Payment for imported goods---进口货物付款                                                                                                       |
| PMT005 | Travel services---旅行服务                                                                                                                    |
| PMT006 | Transfer to own account---转账到自己的账户                                                                                                        |
| PMT007 | Repayment of loans---贷款偿还                                                                                                                 |
| PMT009 | Payment of property rental---支付物业租金                                                                                                       |
| PMT010 | Information Service Charges---信息服务费                                                                                                       |
| PMT011 | Advertising & Public relations-related expenses---广告和公共关系相关费用                                                                             |
| PMT012 | Royalty fees, trademark fees, patent fees, and copyright fees---版权/商标/专利费用                                                                |
| PMT013 | Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee---经济费、保管费、托管费                                            |
| PMT014 | Fees for advisors, technical assistance, and academic knowledge, including remuneration for specialists---顾问费、技术援助、知识费用等---顾问费、技术援助、知识费用等 |
| PMT015 | Representative office expenses---办公室费用                                                                                                    |
| PMT016 | Tax Payment---税费                                                                                                                          |
| PMT017 | Transportation fees for goods---货物运输费用                                                                                                    |
| PMT018 | Construction costs/expenses---建筑成本                                                                                                        |
| PMT019 | Insurance Premium---保险费                                                                                                                   |
| PMT020 | General Goods Trades - Offline trade---一般商品贸易                                                                                             |
| PMT021 | Insurance Claims Payment---保险赔付费用                                                                                                         |
| PMT024 | Medical Treatment---医疗                                                                                                                    |
| PMT025 | Donations---捐赠                                                                                                                            |
| PMT026 | Mutual Fund Investment---投资                                                                                                               |
| PMT027 | Currency Exchange---货币兑换                                                                                                                  |
| PMT028 | Advance Payments for Goods---预付商品款项                                                                                                       |
| PMT029 | Merchant Settlement---商户结算                                                                                                                |
| PMT030 | Repatriation Fund Settlement---遣返/回国资金结算                                                                                                  |

## 国家地区编码

[国家地区编码](/cn/others-resources/country-code)