Create code

Create a WhiteBIT code for transferring funds between accounts or to other users via the V4 API.

POST /api/v4/main-account/codes

Create code

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/main-account/codes \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "ticker": "ETH",
  "amount": "0.002",
  "passphrase": "some passphrase",
  "description": "some description",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

201

Example

{ "code": "WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH", "message": "Code was successfully created", "external_id": "be08a482-5faf-11ed-9b6a-0242ac120002" }

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. Max precision = 8, value must be greater than zero and less than or equal to the main balance.

Example:

"0.002"

request · string · required

Request signature

Example:

"{{request}}"

nonce · string · required

Unique request identifier

Example:

"{{nonce}}"

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: 75 symbols.

Maximum string length: 75

Example:

"some description"

Response

201

application/json

All validations succeeded and creating transaction is started

code · string

Generated WhiteBIT code

message · string

Success message

external_id · string

External identifier