KUCOIN API

Sub-account Transfer

POST

https://api.kucoin.com/api/v2/accounts/sub-transfer

domain:Spot

api-channel:Private

api-permission:Spot

api-rate-limit-pool:Management

sdk-service:Account

sdk-sub-service:Transfer

sdk-method-name:subAccountTransfer

api-rate-limit-weight:30

TIPS

It is recommended to use the GET /api/v3/accounts/universal-transfer endpoint instead of this endpoint

Description

Funds in the main account, trading account and margin account of a Master Account can be transferred to the main account, trading account, futures account and margin account of its Sub-Account. The futures account of both the Master Account and Sub-Account can only accept funds transferred in from the main account, trading account and margin account and cannot transfer out to these 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.

direction

enum<string>

required

OUT — the master user to sub user
IN — the sub user to the master user

Allowed values:

INOUT

accountType

enum<string>

optional

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

Allowed values:

MAINTRADEMARGINCONTRACTOPTION

Default:

MAIN

tag

string

optional

Need to be defined if accountType=ISOLATED.

<= 20 characters

Example:

BTC-USDT

subAccountType

enum<string>

optional

Sub-account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED

Allowed values:

MAINTRADEMARGINCONTRACT

Default:

MAIN

subTag

string

required

Need to be defined if subAccountType=ISOLATED.

<= 20 characters

Example:

BTC-USDT

subUserId

string

optional

the user ID of a sub-account.

Example

{
  "clientOid": "64ccc0f164781800010d8c09",
  "currency": "USDT",
  "amount": "0.01",
  "direction": "OUT",
  "accountType": "MAIN",
  "subAccountType": "MAIN",
  "subUserId": "63743f07e0c5230001761d08"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.kucoin.com/api/v2/accounts/sub-transfer' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientOid": "64ccc0f164781800010d8c09",
    "currency": "USDT",
    "amount": "0.01",
    "direction": "OUT",
    "accountType": "MAIN",
    "subAccountType": "MAIN",
    "subUserId": "63743f07e0c5230001761d08"
}'

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

orderId

string

required

Transfer order ID

Example

{
  "code": "200000",
  "data": {
    "orderId": "670be6b0b1b9080007040a9b"
  }
}

Modified at about 1 month ago

Get Deposit Addresses - V1

Get Deposit History - Old