Skip to main content
Convert Auto Confirm

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

Convert amount direction, defines in which currency corresponding "amount" field is populated. Use "to" in case amount is in "to" currency, use "from" if amount is in "from" currency

Available options:
from,
to
Example:

"from"

amount
string
required

Amount to convert or receive. The value is silently truncated to 8 decimal places before evaluation; excess decimals do not raise an error.

Example:

"0.1"

idempotencyKey
string

Optional idempotency key. Any characters are accepted; the bounds are a length check on a free-form string and never a comparison of a digits-only key as a number, so "12345678" is valid and "123" is too short. A UUID is the usual choice.

Required string length: 8 - 128
Example:

"9f1c2b7e-4d3a-4f21-9c88-6e5b0a71d240"

nonce
integer

Nonce for request

Example:

1699260637

request
string

Request path

Example:

"{{request}}"

Response

Successful response

id
string

Quote ID of the executed conversion. Accepted as the quoteId filter on the convert history endpoint.

Example:

"987654321"

finalGive
string

Final amount given, in the from currency

Example:

"0.10000000"

finalReceive
string

Final amount received, in the to currency

Example:

"6543.21000000"