Transfer between balances

The endpoint transfers the specified amount between main, trade and collateral balances.

Rate limit: 1000 requests/10 sec.

The API does not cache the response.

Also, fiat currencies can’t be transferred without KYC verification.

POST /api/v4/main-account/transfer

cURL

usingMethod

curl --request POST \ --url https://whitebit.com/api/v4/main-account/transfer \ --header 'Content-Type: application/json' \ --header 'X-TXC-APIKEY: <api-key>' \ --data ' { "ticker": "XLM", "amount": "0.9", "method": "deposit", "request": "{{request}}", "nonce": "{{nonce}}" } '

201

Example

[]

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

ticker · string · required

Currency's ticker. Example: BTC

Example:

"XLM"

amount · string · required

Amount to transfer. Max precision = 8, value must be greater than zero and less than or equal to the available balance.

Example:

"0.9"

request · string · required

Request signature

Example:

"{{request}}"

nonce · string · required

Unique request identifier

Example:

"{{nonce}}"

method · enum<string>

Transfer method.

⚠️ We highly recommend to use from and to fields, which provides more flexibility. This way will be deprecated in future.

Example: deposit to transfer from main to trade / withdraw to transfer from trade balance to main. For collateral balances use collateral-deposit to transfer from main to collateral and collateral-withdraw to transfer from collateral to main

Not required if from and to are set.

Available options: deposit, withdraw, collateral-deposit, collateral-withdraw

Example:

"deposit"

from · enum<string>

Balance FROM which funds will move to. Acceptable values: main, spot, collateral

Not required if method is set.

Available options: main, spot, collateral

Example:

"main"

to · enum<string>

Balance TO which funds will move to. Acceptable values: main, spot, collateral

Not required if method is set.

Available options: main, spot, collateral

Example:

"spot"

Response

201

application/json

All validations succeeded and creating transaction is started