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

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

Available options:
from,
to
Example:

"from"

amount
string
required

Amount as a string, such as "0.1". Range: 0.00000001 to 100000000000, inclusive; truncated to 8 decimals. A JSON number may be rounded, and the rounded value is converted.

Example:

"0.1"

idempotencyKey
string

Optional key, 8 to 128 characters of any kind; a UUID is typical. Omit the field instead of sending an empty string: an empty string claims no key, so a retry converts again.

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. The string carries no fixed number of decimal places: 10, not 10.00000000.

Example:

"0.1"

finalReceive
string

Final amount received, in the to currency. The string carries no fixed number of decimal places.

Example:

"6543.21"