KUCOIN API

Flex Transfer

POST

https://api.kucoin.com/api/v3/accounts/universal-transfer

domain:Spot

api-channel:Private

api-permission:FlexTransfers

api-rate-limit-pool:Management

sdk-service:Account

sdk-sub-service:Transfer

sdk-method-name:flexTransfer

api-rate-limit-weight:4

Description

This interface can be used for transfers between master- and sub-accounts and transfers

The API Key needs universal transfer permission when calling.

It supports transfers between master account and sub-accounts, and also supports transfers between different types of accounts.

It supports transfer between master account and sub-accounts (only applicable to master account APIKey).

MARGIN_V2 only supports internal transfers between MARGIN and does not support transfers between master- and sub-accounts.

ISOLATED_V2 only supports internal transfers between ISOLATED and does not support transfers between master- and sub-accounts.

Request

Body Params application/json

clientOid

string

required

Unique order ID created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits

currency

string

required

currency

amount

string

required

Transfer amount: The amount is a positive integer multiple of the currency precision.

type

enum<string>

required

Transfer type: INTERNAL (Transfer within account), PARENT_TO_SUB (Transfer from master-account to sub-account), SUB_TO_PARENT (Transfer from sub-account to master-account)

Allowed values:

INTERNALPARENT_TO_SUBSUB_TO_PARENT

fromAccountType

enum<string>

required

Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2

Allowed values:

MAINTRADECONTRACTMARGINISOLATEDMARGIN_V2ISOLATED_V2OPTION

toAccountType

enum<string>

required

Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2

Allowed values:

MAINTRADECONTRACTMARGINISOLATEDMARGIN_V2ISOLATED_V2OPTION

fromUserId

string

optional

Transfer out UserId: This is required when transferring from sub-account to master-account. It is optional for internal transfers.

fromAccountTag

string

optional

Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT

toUserId

string

optional

Transfer in UserId: This is required when transferring master-account to sub-account. It is optional for internal transfers.

toAccountTag

string

optional

Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT

Example

//transfer from master-account to sub-account
{
  "clientOid": "64ccc0f164781800010d8c09",
  "type": "PARENT_TO_SUB",
  "currency": "USDT",
  "amount": "0.01",
  "fromAccountType": "TRADE",
  "toUserId": "63743f07e0c5230001761d08",
  "toAccountType": "TRADE"
}

//transfer from sub-account to master-account
// {
//   "clientOid": "64ccc0f164781800010d8c09",
//   "type": "SUB_TO_PARENT",
//   "currency": "BTC",
//   "amount": 1,
//   "fromUserId": "62f5f5d4d72aaf000122707e",
//   "fromAccountType": "TRADE",
//   "toAccountType": "CONTRACT"
// }

// internal transfer
// {
//   "clientOid": "53666633336123",
//   "type": "INTERNAL",
//   "currency": "BTC",
//   "amount": 0.0003,
//   "fromAccountType": "TRADE",
//   "toAccountType": "MAIN"
// }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.kucoin.com/api/v3/accounts/universal-transfer' \
--header 'Content-Type: application/json' \
--data-raw '//transfer from master-account to sub-account
{
  "clientOid": "64ccc0f164781800010d8c09",
  "type": "PARENT_TO_SUB",
  "currency": "USDT",
  "amount": "0.01",
  "fromAccountType": "TRADE",
  "toUserId": "63743f07e0c5230001761d08",
  "toAccountType": "TRADE"
}

//transfer from sub-account to master-account
// {
//   "clientOid": "64ccc0f164781800010d8c09",
//   "type": "SUB_TO_PARENT",
//   "currency": "BTC",
//   "amount": 1,
//   "fromUserId": "62f5f5d4d72aaf000122707e",
//   "fromAccountType": "TRADE",
//   "toAccountType": "CONTRACT"
// }

// internal transfer
// {
//   "clientOid": "53666633336123",
//   "type": "INTERNAL",
//   "currency": "BTC",
//   "amount": 0.0003,
//   "fromAccountType": "TRADE",
//   "toAccountType": "MAIN"
// }'

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

orderId

string

required

Transfer order ID

Example

{
  "code": "200000",
  "data": {
    "orderId": "6705f7248c6954000733ecac"
  }
}

Modified at 2025-04-24 10:51:52

Get Transfer Quotas

Get Basic Fee - Spot/Margin