Skip to main content

Used in these guides

  • Payment Integration — crypto deposits, withdrawals, conversion, WhiteBIT Codes, and Express Withdraw.

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
from
string
required

From currency. Example: BTC

Example:

"BTC"

to
string
required

To currency. Example: USDT

Example:

"USDT"

direction
enum<string>
required

Currency that amount is given in: from for the source currency, to for the target currency.

Available options:
from,
to
Example:

"to"

amount
string
required

Amount as a string, such as "35103.1". Range: 0.00000001 to 100000000000, inclusive; truncated to 8 decimals. No thousands separators, leading dot, exponent or spaces.

Example:

"35103.1"

nonce
integer

Nonce for request

Example:

1699260637

request
string

Request path

Example:

"{{request}}"

Response

Successful response

id
string

Quote ID

Example:

"123"

from
string

From currency

Example:

"BTC"

to
string

To currency

Example:

"USDT"

give
string

Amount to give

Example:

"50"

receive
string

Amount to receive

Example:

"1714988.41577452"

rate
string

Conversion rate expressed in the from→to direction: units of the 'to' currency received per one unit of the 'from' currency. Example: if from=BTC and to=USDT, a rate of "34299.76" means 1 BTC is worth approximately 34 299.76 USDT at the time of the quote.

Example:

"34299.76831549"

expireAt
integer

Quote expiration time as a Unix timestamp in seconds, a whole number.

Example:

1699016476