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

# 充值与提现

> 现货 API：充值与提现。

## 获取Monochrome可充提的币种

`GET` `/v4/public/wallet/support/currency`

### 备注

currency  、chain 字段需要在后续充值/提现接口中使用

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": [
    {
        "currency": "BTC",                  //币种
        "supportChains": [
            {
                "chain": "Bitcon",          //支持的转账网络
                "depositEnabled": true,     //是否支持充值，true:支持，false:不支持
                "withdrawEnabled": true,    //是否支持提现，true:支持，false:不支持
                "withdrawFeeAmount": 0.2,   //提现手续费
                "withdrawMinAmount": 10,    //最小提现数量
                "depositFeeRate": 0.2,      //充值费率，百分比
                "contract": "contractaddress" //合约地址
            }
        ]           
    },
    {
        "currency": "ETF",                  //币种
        "supportChains": [
            {
                "chain": "Ethereum",        //支持的转账网络
                "depositEnabled": true,     //是否支持充值，true:支持，false:不支持
                "withdrawEnabled": true,    //是否支持提现，true:支持，false:不支持
                "withdrawFeeAmount": 0.2,   //提现手续费
                "withdrawMinAmount": 10,    //最小提现数量
                "depositFeeRate": 0.2,      //充值费率，百分比
                "contract": "contractaddress" //合约地址
            }
        ]
    }
  ]
}
```

## 获取充值地址

`GET` `/v4/deposit/address`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| chain | string | true | | 转账网络名称 | |
| currency | string | true | | 币种名称 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": {
    "address": "0xfa3abfa50eb2006f5be7831658b17aca240d8526",     //钱包地址
    "memo": ""
  }
}
```

## 充值历史

`GET` `/v4/deposit/history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| currency | string | true | | 币种名称，可从“获取Monochrome可充提的币种”接口中获取 | |
| chain | string | true | | 转账网络名称，可从“获取Monochrome可充提的币种”接口中获取 | |
| status | string | false | | 充值记录的状态 | SUBMIT、REVIEW、AUDITED、PENDING、SUCCESS、FAIL、CANCEL |
| fromId | long | false | | 上次开始分页的Id，即记录的主键id | |
| direction | string | false | NEXT | 分页方向 | NEXT：下一页，PREV：上一页 |
| limit | int | false | 10 | 每页记录数，最大不超过200 | 1\<=limit\<=200 |
| startTime | long | false | | 查询范围开始边界，毫秒级时间戳 | |
| endTime | long | false | | 查询范围结束边界，毫秒级时间戳 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": {
    "hasPrev": true,            //是否有上一页
    "hasNext": true,            //是否有下一页
    "items": [
      {
         "id": 169669597,       //提现记录id
         "currency": "xlm2",    //币种名称
         "chain": "XLM",        //转账网络名称
         "memo": "441824256",   //memo
         "status": "SUCCESS",   //充值状态
         "amount": "0.1",       //充值金额
         "confirmations": 12,   //区块确认数
         "transactionId": "28dd15b5c119e00886517f129e5e1f8283f0286b277bcd3cd1f95f7fd4a1f7fc",   //交易哈希
         "address": "GBY6UIYEYLAAXRQXVO7X5I4BSSCS54EAHTUILXWMW6ONPM3PNEA3LWEC",     //充值目标地址
         "fromAddr": "GBTISB3JK65DG6LEEYYFW33RMMDHBQ65AEUPE5VDBTCLYYFS533FTG6Q",    //来源地址
         "createdTime": 1667260957000   //充值时间，毫秒级时间戳
      }
    ]
  }
}
```

## 提现

`POST` `/v4/withdraw`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| currency | string | true | | 币种名称，可从'获取Monochrome可充提的币种'接口中获取 | |
| chain | string | false | | 转账网络名称，可从'获取Monochrome可充提的币种'接口中获取 | |
| clientOrderId | string | false | | 自定义客户端ID，正则：^\[a-zA-Z0-9\_]\{4,32}\$ | |
| amount | number | true | | 提现金额，包含手续费部分 | |
| address | string | false | | 提现地址 | |
| memo | string | false | | memo，对于EOS类似的需要memo的链必传 | |
| toAccountId | number | false | | 收款用户ID | |

注意：参数以json形式放在body中

### 限流规则

1/s/apikey

```json Request theme={null}
{
    "currency":"zb",
    "chain":"Ethereum",
    "amount":1000,
    "address":"0xfa3abfa50eb2006f5be7831658b17aca240d8526",
    "memo":""
}
```

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {      
        "id": 100    //Long  提现记录id，用于后期查询提现历史记录
    }
}
```

## 提现详情

`GET` `/v4/withdraw`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| recordId | string | false | | 提现记录id，提现接口响应中获取，建议优先使用 | |
| clientOrderId | string | false | | 客户端ID | |

### 限流规则

1/s/apikey

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {      
        "id": 100,                     //提现记录id，用于后期查询提现历史记录
        "clientOrderId": 10,           //客户端ID
        "type": 0,                     //提现类型 CHAIN_TRANSFER-区块链提现 INTERNAL_TRANSFER-内部提现
        "currency": "btc",             //币种
        "address": "xxxxx",            //提现目标地址
        "status": "REVIEW",            //状态，含义见公共模块-充值/提现记录状态码及含义
        "amount": 0.1,                 //提现数量
        "fee": 0.0001,                 //提现手续费
        "chain": "Tron",               //网络
        "memo": "yyyyy",               //memo
        "confirmations": 2,            //区块确认数
        "transactionId": "490267492",  //交易hash
        "createdTime": 1737093343000   //提现时间
    }
}
```

## 提现历史

`GET` `/v4/withdraw/history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| currency | string | true | | 币种名称，可从'获取Monochrome可充提的币种'接口中获取 | |
| chain | string | true | | 转账网络名称，可从'获取Monochrome可充提的币种'接口中获取 | |
| status | string | false | | 提现记录的状态，字符串类型（含义见公共模块-充值/提现记录状态码及含义） | SUBMIT、REVIEW、AUDITED、AUDITED\_AGAIN、PENDING、SUCCESS、FAIL、CANCEL |
| fromId | Long | false | | 上次开始分页的Id，即记录的主键id | |
| direction | String | false | NEXT | 分页方向 | NEXT：下一页，PREV：上一页 |
| limit | int | false | 10 | 每页记录数，最大不超过200 | 1\<=limit\<=200 |
| startTime | Long | false | | 查询范围开始边界，毫秒级时间戳 | |
| endTime | Long | false | | 查询范围结束边界，毫秒级时间戳 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": {
        "hasPrev": true,                       //是否有上一页
        "hasNext": true,                       //是否有下一页
        "items": [
            {
                "id": 763111,                  //提现记录id
                "clientOrderId": 10,           //客户端ID
                "type": 0,                     //提现类型 CHAIN_TRANSFER-区块链提现 INTERNAL_TRANSFER-内部提现
                "currency": "usdt",            //币种名称
                "chain": "Ethereum",           //提现网络
                "address": "0xfa3abfa50eb2",   //提现目标地址
                "memo": "",
                "status": "REVIEW",            //状态，含义见公共模块-充值/提现记录状态码及含义
                "amount": "30",                //提现金额
                "fee": "0",                    //提现手续费
                "confirmations": 0,            //区块确认数
                "transactionId": "",           //交易哈希
                "createdTime": 1667763470000                                
            },
            {
                "id": 763107,
                "clientOrderId": 10, 
                "type": 0,  
                "currency": "usdt",
                "chain": "Tron",
                "address": "TYnJJwaJKkqVvE2zEfUvFbHgKxVBY5zGq9",
                "memo": "",
                "status": "REVIEW",
                "amount": "50",
                "fee": "1",
                "confirmations": 0,
                "transactionId": "",
                "createdTime": 1667428286000
            }
        ]
  }
}
```

## BTCsn充值

`POST` `/v4/nft/deposit`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| currency | string | true | | 币种 | |
| serial | string | true | | 序列号 | |
| passcode | string | true | | 密码 | |

注意：参数以json形式放在body中

```json Request theme={null}
{
    "currencyId":"123",
    "serial":"123456",
    "passcode":12345
}
```

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {      
    }
}
```

## BTCsn充值提现历史

`GET` `/v4/nft/order/history`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| type | number | false | 2 | 类型：1-充值；2-提现 | |
| status | number | false | | 状态：0-已提交；1-审核中；2-已审核；3-已完成；4-拒绝；5-取消 | |
| currency | string | false | | 币种 | |
| startTime | number | false | | 开始时间（时间戳） | |
| endTime | number | false | | 结束时间（时间戳） | |
| page | number | false | | 页码 | |
| size | number | false | | 页大小 | |

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {   
       items:[
          {
              id: 123,
              type: 2,
              currencyId: 2280,
              currencyName: "btcsn",
              amount: 0.01,
              fee: 0.7511888,
              feeCurrencyId: 11, 
              feeCurrencyName: "usdt",
              serial: 123,
              status: 3,
              password: 123456,
              createTime: 1730967448000
          }
       ]
    }
}
```

## BTCsn提现

`POST` `/v4/nft/withdraw`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| currency | string | true | | 币种 | |
| serial | string | true | | 序列号 | |

注意：参数以json形式放在body中

```json Request theme={null}
{
    "currencyId":"123",
    "serial":"123456"
}
```

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {      
    }
}
```


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