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

# Deposit and withdrawal

> Spot API: deposit and withdrawal.

## Get information of currencies (available for deposit and withdraw)

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

### Remark

The currency and chain in the response need to be used in other deposit/withdrawal API

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": [
    {
        "currency": "BTC",                  //currency name
        "supportChains": [
            {
                "chain": "Bitcon",          //supported transfer network
                "depositEnabled": true,     //deposit is supported or not
                "withdrawEnabled": true     //withdraw is supported or not
                "withdrawFeeAmount": 0.2,   //withdraw fee
                "withdrawMinAmount": 10,    //minimum withdrawal amount
                "depositFeeRate": 0.2,      //deposit fee rate
                "contract": "contractaddress" //contract address
            }
        ]           
    },
    {
        "currency": "ETH",                  //currency name
        "supportChains": [
            {
                "chain": "Ethereum",        //supported transfer network
                "depositEnabled": true,     //deposit is supported or not
                "withdrawEnabled": true     //withdraw is supported or not
                "withdrawFeeAmount": 0.2,   //withdraw fee
                "withdrawMinAmount": 10,    //minimum withdrawal amount
                "depositFeeRate": 0.2,       //deposit fee rate
                "contract": "contractaddress" //contract address
            }
        ]
    }
  ]
}
```

## Get the deposit address

`GET` `/v4/deposit/address`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| chain | string | true | | network for deposit | |
| currency | string | true | | currency name | |

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

## Get history records of deposit

`GET` `/v4/deposit/history`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| currency | string | true | | Currency name, can be obtained from the response of "Get the supported currencies for deposit or withdrawal" API | |
| chain | string | true | | Transfer networks, can be obtained from the response of "Get the supported currencies for deposit or withdrawal" API | |
| status | string | false | | The [status](#depositWithdrawStatus) of deposit | SUBMIT、REVIEW、AUDITED、PENDING、SUCCESS、FAIL、CANCEL |
| fromId | long | false | | Start ID, e.g. 6216559590087220004 | |
| direction | string | false | NEXT | query direction | query direction:PREV, NEXT |
| limit | int | false | 10 | Limit number, max 200 | 1\<=limit\<=200 |
| startTime | long | false | | Start time used for filtering deposit list, timestamp in milliseconds | |
| endTime | long | false | | End time used for filtering deposit list, timestamp in milliseconds | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": {
    "hasPrev": true,            //Is there a previous page
    "hasNext": true,            //Is there a next page
    "items": [
      {
         "id": 169669597,       //Unique ID of the deposit record
         "currency": "xlm2",    //Currency name
         "chain": "XLM",        //Transfer Network
         "memo": "441824256",   //memo
         "status": "SUCCESS",   //The status of deposit
         "amount": "0.1",       //Deposit amount
         "confirmations": 12,   //Number of block confirmations
         "transactionId": "28dd15b5c119e00886517f129e5e1f8283f0286b277bcd3cd1f95f7fd4a1f7fc",   //Unique ID of transaction
         "address": "GBY6UIYEYLAAXRQXVO7X5I4BSSCS54EAHTUILXWMW6ONPM3PNEA3LWEC",     //Target address of deposit
         "fromAddr": "GBTISB3JK65DG6LEEYYFW33RMMDHBQ65AEUPE5VDBTCLYYFS533FTG6Q",    //From address of deposit
         "createdTime": 1667260957000   //Time of deposit record in millisecondstime
      }
    ]
  }
}
```

## Withdraw

`POST` `/v4/withdraw`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| currency | string | true | | Currency name, which can be obtained from the 'Get the supported currencies for deposit or withdrawal' interface | |
| chain | string | false | | The name of the transfer network, which can be obtained from the interface of 'Get the supported currencies for deposit or withdrawal' interface | |
| clientOrderId | string | false | | Custom Client ID, regular：^\[a-zA-Z0-9\_]\{4,32}\$ | |
| amount | number | true | | Withdrawal amount, including handling fee | |
| address | string | false | | Withdrawal address | |
| memo | string | false | | memo，For EOS similar chains that require memo must be transferred | |
| toAccountId | number | false | | Receiving user ID | |

Note: The parameters are placed in the body in the form of json

### Limit Flow Rules

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  Withdrawal record id, used for querying withdrawal history later
    }
}
```

## Withdraw Detail

`GET` `/v4/withdraw`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| recordId | string | false | | Withdrawal record id, obtained from the withdrawal endpoint, it is recommended to use it first | |
| clientOrderId | string | false | | Client ID | |

### Limit Flow Rules

1/s/apikey

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {      
        "id": 100,                     //Withdrawal record id
        "clientOrderId": 10,           //Client ID
        "type": 0,                     //Type CHAIN_TRANSFER-Blockchain withdrawal INTERNAL_TRANSFER-Internal withdrawal
        "currency": "btc",             //currency
        "address": "xxxxx",            //Withdrawal address
        "status": "REVIEW",            //Refer to public module-Deposit/withdrawal record status
        "amount": 0.1,                 //Withdrawal Amount
        "fee": 0.0001,                 //Withdrawal Fee
        "chain": "Tron",               //Chain
        "memo": "yyyyy",               //memo
        "confirmations": 2,            //Number of block confirmations
        "transactionId": "490267492",  //Transaction hash
        "createdTime": 1737093343000   //Withdrawal application time, timestamp in milliseconds
    }
}
```

## Withdrawal history

`GET` `/v4/withdraw/history`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| currency | string | true | | Currency name, which can be obtained from the 'Get the supported currencies for deposit or withdrawal' interface | |
| chain | string | true | | The name of the transfer network, which can be obtained from the interface of 'Get the supported currencies for deposit or withdrawal' interface | |
| status | string | false | | The [status](#depositWithdrawStatus) of the withdrawal record, string type，Refer to public module-Deposit/withdrawal status | SUBMIT、REVIEW、AUDITED、AUDITED\_AGAIN、PENDING、SUCCESS、FAIL、CANCEL |
| fromId | Long | false | | The Id of the last pagination, that is, the primary key id of the record | |
| direction | String | false | NEXT | Page direction | NEXT：next page，PREV：previous page |
| limit | int | false | 10 | Number of records per page, maximum 200 | 1\<=limit\<=200 |
| startTime | Long | false | | Query range start boundary, timestamp in milliseconds | |
| endTime | Long | false | | Query range end boundary, timestamp in milliseconds | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "string",
  "ma": [
    {}
  ],
  "result": {
        "hasPrev": true,                      //Is there a previous page                              
        "hasNext": true,                      //Is there a next page                              
        "items": [
            {
                "id": 763111,                 //Withdrawal record id 
                "clientOrderId": 10,          //Client ID
                "type": 0,                    //Type CHAIN_TRANSFER-Blockchain withdrawal INTERNAL_TRANSFER-Internal withdrawal
                "currency": "usdt",           //Currency 
                "chain": "Ethereum",          //Withdraw network 
                "address": "0xfa3abf",        //Withdrawal target address 
                "memo": "",
                "status": "REVIEW",           //Refer to public module-Deposit/withdrawal record status
                "amount": "30",               //Withdrawal Amount
                "fee": "0",                   //Withdrawal fee
                "confirmations": 0,           //Number of block confirmations
                "transactionId": "",          //Transaction hash
                "createdTime": 1667763470000  //Withdrawal application time, timestamp in milliseconds
            },
            {
                "id": 763107,
                "clientOrderId": 10,  
                "type": 0,       
                "currency": "usdt",
                "chain": "Tron",
                "address": "TYnJJw",
                "memo": "",
                "status": "REVIEW",
                "amount": "50",
                "fee": "1",
                "confirmations": 0,
                "transactionId": "",
                "createdTime": 1667428286000
            }
        ]
  }
}
```

## BTCsn deposit

`POST` `/v4/nft/deposit`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| currency | string | true | | currency | |
| serial | string | true | | serial | |
| passcode | string | true | | passcode | |

Note: The parameters are placed in the body in the form of json

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

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

## BTCsn deposit or withdraw history

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

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| type | number | false | 2 | type,1-deposit;2-withdraw | |
| status | number | false | | status,0-submit;1-under review;2-reviewed;3-completed;4-reject;5-cancel | |
| currency | string | false | | currency | |
| startTime | number | false | | start time (timestamp) | |
| endTime | number | false | | end time (timestamp) | |
| page | number | false | | page index | |
| size | number | false | | page size | |

```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 withdraw

`POST` `/v4/nft/withdraw`

**Parameters**

| Parameter | Type | mandatory | Default | Description | Ranges |
| - | - | - | - | - | - |
| currency | string | true | | currency | |
| serial | string | true | | serial | |

Note: The parameters are placed in the body in the form of json

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