FlexTransfer

HTTP REQUEST

POST /api/v3/accounts/universal-transfer

Example

POST /api/v3/accounts/universal-transfer

//internal transfer
{
  "clientOid": "64ccc0f164781800010d8c09",
  "type": "INTERNAL",
  "currency": "BTC",
  "amount": 1,
  "fromAccountType": "TRADE",
  "toAccountType": ""
}

//master-sub transfer - transfer from master-uid to sub-uid
{
  "clientOid": "64ccc0f164781800010d8c09",
  "type": "PARENT_TO_SUB",
  "currency": "BTC",
  "amount": 1,
  "fromAccountType": "TRADE",
  "toUserId": "62f5f5d4d72aaf000122707e",
  "toAccountType": "MAIN"
}

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

API KEY PERMISSIONS

This endpoint requires the FlexTransfers permission.

REQUEST URL

This endpoint support Spot URL

REQUEST RATE LIMIT

Manage weight：4

PARAMETERS

Param	Type	Mandatory	Description
clientOid	String	Yes	Unique order id created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits
currency	String	No	Currency
amount	String	Yes	Transfer amount, the amount is a positive integer multiple of the currency precision.
fromUserId	String	No	Transfer out UserId， This is required when transferring sub-account to master-account. It is optional for internal transfers.
fromAccountType	String	Yes	Account type：MAIN、TRADE
type	String	Yes	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)
toUserId	String	No	Transfer in UserId， This is required when transferring master-account to sub-account. It is optional for internal transfers.
toAccountType	String	Yes	Account type：MAIN、TRADE

RESPONSES

Param	Description
orderId	Transfer order ID

Description

1. The API Key needs to have universal transfer permission when calling.

2. Support internal transfer,do not support transfers between sub-accounts.

3. Support transfer between master and sub accounts (only applicable to master account APIKey).