Skip to navigation
API ReferenceFunding

Funds transfer

Transfer funds between your funding account and trading account, and between the master account and sub-accounts. Only API keys with Trade privilege can call this endpoint.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
ccystringRequired
Currency, e.g. USDT.
amtstringRequired
Amount to be transferred.
fromenumRequired

The remitting account: 6=Funding account, 18=Trading account.

Allowed values:
toenumRequired

The beneficiary account: 6=Funding account, 18=Trading account.

Allowed values:
subAcctstringOptional

Name of the sub-account. Required when type is 1, 2, or 4.

typeenumOptional

Transfer type: 0=within account, 1=master-to-subaccount (by master), 2=subaccount-to-master (by master), 3=subaccount-to-master (by sub), 4=subaccount-to-subaccount. Default is 0.

Allowed values:
loanTransbooleanOptional

Whether or not borrowed coins can be transferred out under Multi-currency margin/Portfolio margin. Default is false.

clientIdstringOptional

Client-supplied ID. A combination of case-sensitive alphanumerics, up to 32 characters.

omitPosRiskstringOptional
Ignore position risk. Default is false. Applicable to Portfolio margin.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional