Initiate an asset transfer between accounts. Supported transfer types include: Intra-exchange transfer, Cross-exchange transfer, Transfer between Funding Accounts and Trading Portfolios, Transfer between Trading Accounts. Note: Only API keys with Transfer permissions are authorized to call this endpoint.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
TipsApplies to both user and trading portfolio's API Key. Permission: TRANSFER.
Request
| Field name | Type | Necessary | Remarks |
|---|---|---|---|
| fromTradeAccountId | Long | Y | Outgoing Trade account ID (obtained through Trade account list) This field is applicable to Exchange account, Funding Account, CL Trading Account and Trading Portfolio's ID. |
| toTradeAccountId | Long | Y | Posting Trade account ID (obtained through Trade account list) This field is applicable to Exchange account, Funding Account, CL Trading Account and Trading Portfolio's ID. |
| fromAccountType | String | Conditional | - When fromAccount is a Trading Portfolio, this field is required. fromAccountType(for Trading Portfolio): OKX, BINANCE, EDX - When fromAccount is not a Trading Portfolio: fromAccountType(for Exchange Account): Please check the list below. |
| toAccountType | String | Conditional | - When toAccount is Trading Portfolio, this field is required. toAccountType(for Trading Portfolio): OKX, BINANCE, EDX - When toAccount is not aTrading Portfolio: toAccountType(for Exchange Account): Please check the list below. |
| currency | String | Y | Currency |
| network | String | N | This field is only effective for cross-exchange transfers and Funding Acct. related transfers. |
| amount | String | Y | Quantity (minimum amount :Depend on On-Chain or Exchange Precision Requirements) |
| rapidTransfer | Boolean | Conditional | Rapid Transfer currently supports USDT only, and applies to transfers between two trading accounts on the supported venues (Binance, RapidX, Bybit, OKX, Gate, Bitget, Deribit, Coinbase). Transfers involving your Funding Account are not eligible. If the pool at the receiving venue is short of quota, the request continues through the standard transfer flow instead of failing. See the Rapid Transfer guide. |
| clientOrderId | String | N | The unique user-defined id |
| loanTrans | Boolean | N | Only the trading account from OKX exchange supports this feature. Other accounts don't support this feature. |
Response
| Field name | Type | Remarks |
|---|---|---|
| transferId | Long | Transfer ID |
Details
1. API Key
| API Key | Permission |
|---|---|
| Primary user’s API Key | - Supports transfers between the funding account and all Trading Portfolios; - Supports transfers between all Trading Portfolios under the same primary user. |
| Trading Portfolio API Key: | - Only supports transfers between different exchanges within the API-owned Trading Portfolio. |
2. Account Type
| Exchange | Account type |
|---|---|
| Binance | Classic Account: Spot, Margin, USDT/C-M, Coin-M PM Account: Spot, Margin-PM For transfer of Margin-PM account, it may take approximately one hour due to processing times at the exchange. |
| OKX | Funding, Trading |
| Bybit | Classic Account: Spot, Funding, USDT-M, Coin-M PM Account: Funding, Trading, Coin-M |
| Kucoin | Classic Account: Funding, Trading, USDT/C-M, Coin-M,Cross PM Account: Unified Account, Funding |
| Gate | Classic Account: Spot, USDT-M Delivery Account, USDT-M Perpetual Account, BTC-M Perpetual Account PM Account: Unified Account, USDT-M Delivery Account, USDT-M Perpetual Account(Depends if you open the setting), BTC-M Perpetual Account Switching between Unified Account and Classic Account may take several minutes to half an hour to synchronize the balance. |
| Bitget | Classic Account: Spot, Margin, USDT-M, USDC-M, Coin-M PM Account: Unified Account, Funding |
| PHEMEX | Spot, USDT/C-M, Coin-M |
| LTP-Trading Portfolio | OKX, BINANCE |
3. Network
TRC20, BTC, ERC20, BSC, etc. Please refer to the Get Currencies interface for more details.