> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Payout Destination

> Set or update the payout destination for mining rewards via the WhiteBIT V4 API.



## OpenAPI

````yaml /openapi/private/main_api_v4.yaml POST /api/v4/mining/payout-destination/edit
openapi: 3.0.3
info:
  title: WhiteBIT Private HTTP API V4
  description: |
    WhiteBIT Private HTTP API V4 for Main balance changes.

    Base URL: https://whitebit.com

    All endpoints return time in Unix-time format.
    All endpoints return either a JSON object or array.
    For receiving responses from API calls please use http method POST.
  version: 4.0.0
  contact:
    name: WhiteBIT Support
    email: support@whitebit.com
    url: https://whitebit.com
servers:
  - url: https://whitebit.com
    description: WhiteBIT Global Server
  - url: https://whitebit.eu
    description: WhiteBIT EU Server
security:
  - ApiKeyAuth: []
    PayloadAuth: []
    SignatureAuth: []
tags:
  - name: Main Account
    description: Main account balance and operations
  - name: Deposit
    description: Cryptocurrency and fiat deposit operations
  - name: Withdraw
    description: Cryptocurrency and fiat withdrawal operations
  - name: Transfer
    description: Balance transfer operations
  - name: Codes
    description: WhiteBIT codes operations
  - name: Crypto Lending - Fixed
    description: Fixed crypto lending plans
  - name: Crypto Lending - Flex
    description: Flexible crypto lending plans
  - name: Fees
    description: Fee information
  - name: Sub-Account
    description: Sub-account management
  - name: Sub-Account API Keys
    description: Sub-account API key management
  - name: Mining Pool
    description: Mining pool operations
  - name: Credit Line
    description: Credit line information
  - name: JWT
    description: JWT token management
paths:
  /api/v4/mining/payout-destination/edit:
    post:
      tags:
        - Mining Pool
      summary: Set Payout Destination
      description: >
        Updates the payout destination for a specific mining account belonging
        to the authenticated user. Can be set to main balance or an external BTC
        address.


        <Warning>

        Rate limit: 1000 requests/10 sec.

        </Warning>
      operationId: setMiningPayoutDestination
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - accountName
                - destination
              properties:
                accountName:
                  type: string
                  description: Mining pool account name
                  example: my_miner_01
                destination:
                  type: string
                  enum:
                    - main_balance
                    - external_address
                  description: Payout destination type
                  example: external_address
                address:
                  type: string
                  maxLength: 100
                  description: >-
                    External BTC address. Required when destination is
                    external_address. Supports all standard Bitcoin address
                    formats.
                  example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  payoutDestination:
                    type: string
                    enum:
                      - main_balance
                      - external_address
                  externalAddress:
                    type: string
                    nullable: true
              example:
                payoutDestination: external_address
                externalAddress: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
        '400':
          description: >
            Validation failed. The `address` must match the standard BTC address

            regex (legacy `1…`, `3…`, and bech32 `bc1…`). Some `errors` values
            are

            translation keys that may render as localized strings.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  errors:
                    type: object
              examples:
                accountNotFound:
                  summary: Mining account not found
                  value:
                    code: 0
                    message: Validation failed
                    errors:
                      user:
                        - Mining account not found.
                invalidBtcAddress:
                  summary: address fails BTC format validation
                  value:
                    code: 0
                    message: Validation failed
                    errors:
                      address:
                        - >-
                          miningPool.validation.payoutDestination.invalidBtcAddress
                btcAddressRequired:
                  summary: >-
                    destination is external_address but address is missing or
                    empty
                  value:
                    code: 0
                    message: Validation failed
                    errors:
                      address:
                        - >-
                          miningPool.validation.payoutDestination.btcAddressRequired
                customCurrencyConflict:
                  summary: destination / currency mismatch
                  value:
                    code: 0
                    message: Validation failed
                    errors:
                      destination:
                        - >-
                          miningPool.validation.payoutDestination.customCurrencyConflict
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-TXC-APIKEY
      description: The public WhiteBIT API key.
    PayloadAuth:
      type: apiKey
      in: header
      name: X-TXC-PAYLOAD
      description: Base64-encoded JSON request body.
    SignatureAuth:
      type: apiKey
      in: header
      name: X-TXC-SIGNATURE
      description: >-
        HMAC-SHA512 signature of the payload, hex-encoded. Computed as
        hex(HMAC-SHA512(payload, api_secret)).

````