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

# Add withdrawal address

> Add a withdrawal (payout) wallet address for stable coins. If the same address, network, and token are sent with a different label, the existing address is updated instead of creating a duplicate. Maximum 3 addresses per user.



## OpenAPI

````yaml /api-reference/openapi.json post /payments/wallet-addresses
openapi: 3.0.0
info:
  title: BREET PUBLIC API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://breet.io/terms
servers:
  - url: https://api.breet.io/v1
security:
  - appId: []
    appSecret: []
    breetEnv: []
tags:
  - name: Crypto Wallet
    description: Generate and manage crypto wallet addresses for receiving deposits.
    x-group: Wallets and Deposits
  - name: Withdrawals
    description: >-
      ## Withdrawals


      To help protect your funds, withdrawals support an additional security
      layer through **IP whitelisting**.


      ### IP Whitelisting


      When IP whitelisting is enabled, all withdrawal requests must originate
      from an approved IP address. Any withdrawal request coming from an IP not
      on the whitelist will be automatically blocked.


      You can add up to **7 IP addresses** from your dashboard.


      This feature is recommended for:


      - Production servers
          
      - Preventing unauthorized withdrawal attempts
          

      ### How it works


      - Enable IP whitelisting from your dashboard
          
      - Add up to 7 trusted IP addresses
          
      - Only requests from those IPs will be allowed to initiate withdrawals
          

      If IP whitelisting is disabled, withdrawals can be initiated from any IP
      address.
  - name: Banks
    description: List, validate, add, and remove bank accounts for fiat withdrawals.
  - name: Transactions
    description: Retrieve deposit and trade transaction history.
  - name: Webhooks
    description: >-
      Inspect and retry **outgoing** webhooks we send to your server (trade and
      withdrawal events). Requires an active integration with API access (VIP
      partners). For **incoming** payload shapes and verification, see the
      Webhooks guide in the Guides tab.
  - name: Assets
    description: >-
      Retrieve the list of supported deposit/sell assets and their
      configuration.
  - name: Rates and Prices
    description: >-
      Get live market prices and calculate conversion rates. These endpoints are
      public and do not require authentication.
  - name: Account
    description: Retrieve and update integration account details and preferences.
  - name: Testing
    description: Endpoints for testing your integration in development.
  - name: Conversion
    description: >-
      Convert between USD and local fiat (NGN | GHS). Available for both user
      and integration (business) flows.
  - name: Wallet addresses
    description: >-
      Add and remove withdrawal (payout) wallet addresses. If the same address,
      network, and token are sent with a different label, the existing address
      is updated.
paths:
  /payments/wallet-addresses:
    post:
      tags:
        - Wallet addresses
      summary: Add withdrawal address
      description: >-
        Add a withdrawal (payout) wallet address for stable coins. If the same
        address, network, and token are sent with a different label, the
        existing address is updated instead of creating a duplicate. Maximum 3
        addresses per user.
      operationId: addWithdrawalAddress
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - address
                - network
                - token
                - label
              properties:
                address:
                  type: string
                  description: The wallet address (valid for the given network).
                  example: 14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5
                network:
                  type: string
                  description: 'Blockchain network. Supported: ERC20, TRC20, BSC, SOL, TON.'
                  enum:
                    - ERC20
                    - TRC20
                    - BSC
                    - SOL
                    - TON
                token:
                  type: string
                  description: Token symbol.
                  enum:
                    - USDT
                    - USDC
                label:
                  type: string
                  description: A label for this address (e.g. for display or reference).
            example:
              address: 14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5
              network: SOL
              token: USDT
              label: Main payout wallet
      responses:
        '200':
          description: Address added or updated successfully
          content:
            application/json:
              examples:
                added:
                  summary: Address added
                  value:
                    message: wallet address added successfully
                    success: true
                    data:
                      _id: 6932dc98c2ceccdea367388a
                      user: 68ca0d24604d65932aac2fc8
                      address: 14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5
                      network: SOL
                      token: USDT
                      label: Main payout wallet
                      avatar: >-
                        https://assets.breet.io/token-network-assets/USDT_SOL.png
                      id: 6932dc98c2ceccdea367388a
                    meta: {}
                    summary: {}
                    stats: {}
                updated:
                  summary: Address updated (same address/network/token, new label)
                  value:
                    message: wallet address updated successfully
                    success: true
                    data:
                      _id: 6932dc98c2ceccdea367388a
                      user: 68ca0d24604d65932aac2fc8
                      address: 14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5
                      network: SOL
                      token: USDT
                      label: Updated label
                      avatar: >-
                        https://assets.breet.io/token-network-assets/USDT_SOL.png
                      id: 6932dc98c2ceccdea367388a
                    meta: {}
                    summary: {}
                    stats: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Breet address not allowed or max addresses reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                breetAddress:
                  summary: Cannot use Breet wallet address
                  value:
                    success: false
                    message: >-
                      you can not use a Breet wallet address for this action.
                      Please enter a valid external wallet address
                    meta: {}
                    errors: []
                    data: {}
                maxAddresses:
                  summary: Maximum 3 addresses
                  value:
                    success: false
                    message: you cannot add more than 3 wallet addresses
                    meta: {}
                    errors: []
                    data: {}
        '422':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: Invalid or missing API credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notAuthenticated:
              summary: Missing credentials
              value:
                success: false
                message: you're not authenticated
                meta: {}
                errors: []
                data: {}
            wrongCredentials:
              summary: Invalid app ID or secret
              value:
                success: false
                message: wrong app id and secret combination
                meta: {}
                errors: []
                data: {}
    ValidationError:
      description: >-
        Request validation failed — check the errors array for field-level
        details
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: validation errors
            meta: {}
            errors:
              - message: Invalid value
                field: amount
                location: body
            data: {}
    InternalServerError:
      description: An unexpected server error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: something went wrong!
            meta: {}
            errors: []
            data: {}
  schemas:
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        meta:
          type: object
        errors:
          type: array
          items:
            type: object
        data:
          type: object
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-app-id
      description: Your application ID from the Breet dashboard
    appSecret:
      type: apiKey
      in: header
      name: x-app-secret
      description: Your application secret from the Breet dashboard
    breetEnv:
      type: apiKey
      in: header
      name: X-Breet-Env
      description: 'Environment selector: development or production'

````