Create code

Create a WhiteBIT code for transferring funds between accounts off-chain.

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}}"
}
'

import requests

url = "https://whitebit.com/api/v4/main-account/codes"

payload = {
    "ticker": "ETH",
    "amount": "0.002",
    "passphrase": "some passphrase",
    "description": "some description",
    "request": "{{request}}",
    "nonce": "{{nonce}}"
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-TXC-APIKEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ticker: 'ETH',
    amount: '0.002',
    passphrase: 'some passphrase',
    description: 'some description',
    request: '{{request}}',
    nonce: '{{nonce}}'
  })
};

fetch('https://whitebit.com/api/v4/main-account/codes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/main-account/codes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ticker' => 'ETH',
    'amount' => '0.002',
    'passphrase' => 'some passphrase',
    'description' => 'some description',
    'request' => '{{request}}',
    'nonce' => '{{nonce}}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/main-account/codes"

	payload := strings.NewReader("{\n  \"ticker\": \"ETH\",\n  \"amount\": \"0.002\",\n  \"passphrase\": \"some passphrase\",\n  \"description\": \"some description\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/main-account/codes")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ticker\": \"ETH\",\n  \"amount\": \"0.002\",\n  \"passphrase\": \"some passphrase\",\n  \"description\": \"some description\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/main-account/codes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ticker\": \"ETH\",\n  \"amount\": \"0.002\",\n  \"passphrase\": \"some passphrase\",\n  \"description\": \"some description\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

response = http.request(request)
puts response.read_body

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: 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