KUCOIN API

Transfer

POST

https://api-broker.kucoin.com/api/v1/broker/nd/transfer

domain:Broker

api-channel:Private

api-permission:General

api-rate-limit-pool:Broker

sdk-service:Broker

sdk-sub-service:NDBroker

sdk-method-name:transfer

api-rate-limit-weight:1

Description

This endpoint supports fund transfer between Broker accounts and Broker sub-accounts.

Please be aware that withdrawal from sub-accounts is not directly supported. Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals.

Request

Body Params application/json

currency

string

required

Currency

amount

string

required

Transfer Amount (must be a positive integer in the currency's precision)

clientOid

string

required

Client Order ID, the unique identifier created by the client. It is recommended to use UUID. The maximum length is 128 bits.

<= 128 characters

direction

enum<string>

required

Fund transfer direction: OUT (Broker account is transferred to Broker sub-account), IN (Broker sub-account is transferred to Broker account)

Allowed values:

OUTIN

accountType

enum<string>

required

Broker account types: MAIN (Funding account), TRADE (Spot trading account)

Allowed values:

MAINTRADE

specialUid

string

required

Broker sub-account UID, must be the Broker sub-account created by the current Broker user.

specialAccountType

enum<string>

required

Broker sub-account types: MAIN (Funding account), TRADE (Spot trading account)

Allowed values:

MAINTRADE

Example

{
  "currency": "USDT",
  "amount": "1",
  "clientOid": "e6c24d23-6bc2-401b-bf9e-55e2daddfbc1",
  "direction": "OUT",
  "accountType": "MAIN",
  "specialUid": "226383154",
  "specialAccountType": "MAIN"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-broker.kucoin.com/api/v1/broker/nd/transfer' \
--header 'Content-Type: application/json' \
--data-raw '{
    "currency": "USDT",
    "amount": "1",
    "clientOid": "e6c24d23-6bc2-401b-bf9e-55e2daddfbc1",
    "direction": "OUT",
    "accountType": "MAIN",
    "specialUid": "226383154",
    "specialAccountType": "MAIN"
}'

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

orderId

string

required

Example

{
  "code": "200000",
  "data": {
    "orderId": "671b4600c1e3dd000726866d"
  }
}

Modified at about 1 month ago

Delete sub-account API

Get Transfer History