Broker Transfer

//Broker users transfer to Broker sub-accounts
{
  "clientOid": "64ccc0f164781800010d8c09",
  "direction": "OUT",
  "currency": "BTC",
  "amount": 1,
  "accountType": "TRADE",
  "specialUid": 16614976363288353,
  "specialAccountType": "MAIN"
}

//Transferring Broker sub-account to Broker user
{
  "clientOid": "64ccc0f164781800010d8c09",
  "direction": "IN",
  "currency": "BTC",
  "amount": 1,
  "specialUid": 16614976363288353,
  "specialAccountType": "TRADE",
  "accountType": "MAIN"
}

//Response example
{
  "orderId": "65bef1f82f1dc4000766e2e9"
}

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

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

HTTP REQUEST

POST /api/v1/broker/nd/transfer

Example

POST /api/v1/broker/nd/transfer

REQUEST URL

This endpoint support Broker URL

REQUEST RATE LIMIT

Broker weight：1

PARAMETERS

Param	Type	Mandatory	Description
clientOid	String	Yes	Client Order Id, The unique identifier created by the client. It is recommended to use UUID. The maximum length is 128 bits.
currency	String	Yes	Currency
amount	String	Yes	Transfer amount
direction	String	Yes	Fund transfer direction: OUT (Broker account is transferred to Broker sub-account), IN (Broker sub-account is transferred to Broker account)
accountType	String	Yes	Broker account types: MAIN (Funding account), TRADE (Spot trading account)
specialUid	Long	Yes	Broker subaccount uid, must be the Broker subaccount created by the current Broker user.
specialAccountType	String	Yes	Broker sub-account types: MAIN (Funding account), TRADE (Spot trading account)

RESPONSES

Param	Description
orderId	Transfer order ID

Description

1. The API Key needs to have BROKER_MANAGEMENT permission when request.
2. The APIKEY can be created under broker account only.