Apply code

Apply a WhiteBIT code to an account to receive the associated funds via the V4 API.

POST /api/v4/main-account/codes/apply

Apply code

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/main-account/codes/apply \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "code": "WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH",
  "passphrase": "some passphrase",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

201

Example

{ "message": "Code was successfully applied", "ticker": "ETH", "amount": "0.002", "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

code · string · required

Code that will be applied.

Example:

"WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH"

request · string · required

Request signature

Example:

"{{request}}"

nonce · string · required

Unique request identifier

Example:

"{{nonce}}"

passphrase · string

Should be provided if the code was created with passphrase. Max: 25 symbols.

Maximum string length: 25

Example:

"some passphrase"

Response

201

application/json

All validations succeeded and creating transaction is started

message · string

ticker · string

amount · string

external_id · string