Set Payout Destination

POST /api/v4/mining/payout-destination/edit

Set Payout Destination

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/mining/payout-destination/edit \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "accountName": "my_miner_01",
  "destination": "external_address",
  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}
'

import requests

url = "https://whitebit.com/api/v4/mining/payout-destination/edit"

payload = {
    "accountName": "my_miner_01",
    "destination": "external_address",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}
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({
    accountName: 'my_miner_01',
    destination: 'external_address',
    address: 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh'
  })
};

fetch('https://whitebit.com/api/v4/mining/payout-destination/edit', 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/mining/payout-destination/edit",
  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([
    'accountName' => 'my_miner_01',
    'destination' => 'external_address',
    'address' => 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh'
  ]),
  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/mining/payout-destination/edit"

	payload := strings.NewReader("{\n  \"accountName\": \"my_miner_01\",\n  \"destination\": \"external_address\",\n  \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\"\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/mining/payout-destination/edit")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountName\": \"my_miner_01\",\n  \"destination\": \"external_address\",\n  \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/mining/payout-destination/edit")

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  \"accountName\": \"my_miner_01\",\n  \"destination\": \"external_address\",\n  \"address\": \"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh\"\n}"

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

200

{
  "payoutDestination": "external_address",
  "externalAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}

{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "user": [
      "Mining account not found."
    ]
  }
}

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

accountName · string · required

Mining pool account name

Example:

"my_miner_01"

destination · enum<string> · required

Payout destination type

Available options: main_balance, external_address

Example:

"external_address"

address · string

External BTC address. Required when destination is external_address. Supports all standard Bitcoin address formats.

Maximum string length: 100

Example:

"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

Response

200

application/json

Successful response

payoutDestination · enum<string>

Available options: main_balance, external_address

externalAddress · string | null