v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB

Codes

Create code

The endpoint creates WhiteBIT code.

<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>

post/api/v4/main-account/codes

Request body

tickerstring required

Currency's ticker. Example: BTC

amountstring 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.

passphrasestring

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

descriptionstring

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

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "ticker": "ETH",
  "amount": "0.002",
  "passphrase": "some passphrase",
  "description": "some description",
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

All validations succeeded and creating transaction is started

codestring

Generated WhiteBIT code

messagestring

Success message

external_idstring

External identifier