Create code

This endpoint creates WhiteBIT code.

Rate limit: 1000 requests/10 sec.

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>' \
  --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

API key authentication using signed requests

Body

application/json

ticker · string · required

Currency's ticker.

Example:

"ETH"

amount · string · required

Amount to transfer. Max precision = 8, value should be greater than zero and your main balance.

Example:

"0.002"

request · string · required

Request signature

nonce · string · required

Unique request identifier

passphrase · string

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

Maximum string length: 25

description · string

Additional text description for WhiteBIT codes. Visible only for creator.

Maximum string length: 75

Response

201

application/json

All validations succeeded and creating transaction is started

code · string

Generated WhiteBIT code

message · string

external_id · string