Skip to main content
Create code

Authorizations

X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
ticker
string
required

Currency's ticker. Example: BTC

Example:

"ETH"

amount
string
required

Amount to transfer. Up to 18 decimal places, value greater than zero and capped at 1e17 (10^17), and not exceeding the main balance.

Example:

"0.002"

request
string
required

Request signature

Example:

"{{request}}"

nonce
integer
required

Unique request identifier

Example:

1594297865000

passphrase
string

Passphrase for applying WhiteBIT codes. Passphrase must contain only latin letters, numbers and symbols (like !@#$%^, no whitespaces). Max: 25 symbols.

Maximum string length: 25
Example:

"some passphrase"

description
string

Additional text description for code. Visible only for creator. Max: 280 symbols.

Maximum string length: 280
Example:

"some description"

Response

All validations succeeded and creating transaction is started

code
string

Generated WhiteBIT code

message
string

Success message

external_id
string

External identifier