Skip to main content
POST
/
api
/
v4
/
mining
/
payout-destination
/
edit
Set Payout Destination
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"
}
'
{
  "payoutDestination": "external_address",
  "externalAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}

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 (P2PKH, P2SH, and bech32). Omitting this field when destination is external_address returns: {"code":0,"errors":{"name":["The address field is required."]},"message":"Validation failed"}.

Maximum string length: 100
Example:

"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

Response

Successful response

​
payoutDestination
enum<string>
Available options:
main_balance,
external_address
​
externalAddress
string | null