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

# Withdraw funds

> Initiates a withdrawal from the wallet. Idempotent on `requestId` — if a withdrawal with the same `requestId` already exists, the existing withdrawal is returned. The token is required. USDC supports the documented CCTP chain set; USDT supports Ethereum only in production and Ethereum Sepolia in sandbox.



## OpenAPI

````yaml swagger/swagger-combined.yaml POST /v2/wallets/{id}/withdrawals
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for portfolio wallets, deposits, withdrawals, and webhooks.
  version: 2.0.0
servers:
  - url: https://sandbox.groundtech.co
  - url: https://production.groundtech.co
security:
  - bearerAuth: []
tags:
  - name: System
    description: System health and utility endpoints.
  - name: Sandbox Faucets
    description: Sandbox-only test token faucets.
  - name: Portfolio Wallets
    description: >-
      Portfolio wallets with strategy allocation, deposits, withdrawals, and
      yield positions.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/wallets/{id}/withdrawals:
    post:
      tags:
        - Portfolio Wallets
      summary: Initiate a withdrawal
      description: >-
        Initiates a withdrawal from the wallet. Idempotent on `requestId` — if a
        withdrawal with the same `requestId` already exists, the existing
        withdrawal is returned. The token is required. USDC supports the
        documented CCTP chain set; USDT supports Ethereum only in production and
        Ethereum Sepolia in sandbox.
      operationId: withdrawWalletV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Wallet ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - requestId
                - destinationChain
                - amountUsd
                - token
                - destinationAddress
              properties:
                requestId:
                  type: string
                  format: uuid
                  description: Client-generated idempotency key (UUID v4).
                token:
                  $ref: '#/components/schemas/PortfolioWalletStrategyToken'
                destinationChain:
                  type: string
                  description: >-
                    Destination chain for the withdrawal. Production chains are
                    `arbitrum`, `base`, `ethereum`, `polygon`, and `solana`;
                    sandbox accepts `ethereum_sepolia` and `solana_devnet`.
                  enum:
                    - arbitrum
                    - base
                    - ethereum
                    - ethereum_sepolia
                    - polygon
                    - solana
                    - solana_devnet
                amountUsd:
                  type: number
                  format: double
                  description: Amount to withdraw in USD terms.
                destinationAddress:
                  type: string
                  description: >-
                    On-chain destination address. Use an EVM hex address for EVM
                    chains or a base58 address for `solana`.
            example:
              requestId: f4a5b6c7-0000-4000-8000-000000000001
              destinationChain: arbitrum
              amountUsd: 50
              token: usdc
              destinationAddress: '0x76F8fc6667E239f83a547d4e16225d6a34f6FA22'
      responses:
        '200':
          description: >-
            Withdrawal initiated (or existing withdrawal returned for idempotent
            retry)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Withdrawal'
              example:
                id: w1a2b3c4-0000-4000-8000-000000000001
                amountRequestedUsd: '50.000000'
                amountPaidUsd: null
                feeUsd: '0.000000'
                destinationChain: arbitrum
                destinationAddress: '0x76F8fc6667E239f83a547d4e16225d6a34f6FA22'
                destinationToken: usdc
                status: processing
                failureReason: null
                createdAt: '2025-09-05T10:00:00Z'
                completedAt: null
                legsCompleted: 0
                legsTotal: 0
                payoutLegs: []
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unsupported_chain:
                  value:
                    error: Unsupported chain
                    code: unsupported_chain
                invalid_destination_address:
                  value:
                    error: Invalid destination address
                    code: invalid_destination_address
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Withdrawal approval policy required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: >-
                  Production withdrawal limit reached. Contact Ground to
                  increase your limit.
                code: withdrawal_policy_required
        '404':
          description: Wallet not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                wallet_not_found:
                  value:
                    error: Wallet not found
                    code: wallet_not_found
        '409':
          description: >-
            Conflict. Either there are insufficient unreserved funds
            (`insufficient_funds`), or the same `requestId` was reused with a
            divergent payload (`request_id_conflict`). An identical replay
            returns `200` with the existing withdrawal instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientFundsError'
              examples:
                insufficient_funds:
                  value:
                    error: Insufficient unreserved funds for this destination
                    code: insufficient_funds
                    requestedAmountUsd: 1000
                    grossUsd: 800
                    encumbrancesUsd: 100
                    netUsd: 700
                request_id_conflict:
                  summary: requestId reused with a different withdrawal payload
                  value:
                    error: requestId has already been used with a different payload
                    code: request_id_conflict
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    PortfolioWalletStrategyToken:
      type: string
      enum:
        - usdc
        - usdt
      description: >-
        Stablecoin lane used to validate, fund, rebalance, and withdraw an
        allocation independently from other token lanes.
    Withdrawal:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amountRequestedUsd:
          type: string
          nullable: true
          description: Requested withdrawal amount in USD as a formatted string.
        amountPaidUsd:
          type: string
          nullable: true
          description: >-
            Completed payout amount in USD as a formatted string. Null until at
            least one payout completes.
        feeUsd:
          type: string
          nullable: true
          description: Fee charged for the withdrawal as a formatted string.
        destinationChain:
          type: string
          description: Destination chain for the withdrawal.
          enum:
            - arbitrum
            - base
            - ethereum
            - ethereum_sepolia
            - polygon
            - solana
            - solana_devnet
        destinationAddress:
          type: string
        destinationToken:
          type: string
          enum:
            - usdc
            - usdt
          nullable: true
        status:
          type: string
          enum:
            - processing
            - completed
            - partially_completed
            - failed
            - cancelled
          description: >-
            Simplified withdrawal status. `partially_completed` means at least
            one payout leg delivered value and at least one leg failed or was
            cancelled.
        legsCompleted:
          type: integer
        legsTotal:
          type: integer
        payoutLegs:
          type: array
          items:
            $ref: '#/components/schemas/WalletWorkflowLeg'
          description: Source-to-destination payout workflow legs.
        failureReason:
          type: string
          nullable: true
          description: >-
            Human-readable reason for failure (only present when status is
            `failed`).
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: >-
            Human-readable error message. May change without notice; do not
            parse programmatically.
        code:
          type: string
          description: >-
            Machine-readable error code. Stable across API versions — safe to
            switch on in client code.
          enum:
            - validation_error
            - unknown_parameters
            - unsupported_chain
            - unsupported_token
            - invalid_destination_address
            - precision_overflow
            - invalid_cursor
            - unauthenticated
            - forbidden
            - wallet_not_found
            - wallet_limit_reached
            - withdrawal_not_found
            - deposit_not_found
            - yield_source_not_found
            - wallet_projection_unavailable
            - insufficient_funds
            - duplicate_request_id
            - request_id_conflict
            - invalid_position_weight
            - invalid_withdrawal_plan
            - payout_not_found
            - webhook_not_found
            - webhook_duplicate_url
            - withdrawal_not_cancellable
            - withdrawal_already_cancelled
            - withdrawal_payout_in_progress
            - withdrawal_policy_required
            - workflow_conflict
            - payout_already_terminal
            - payout_in_progress
            - payout_not_retryable
            - address_book_entry_not_found
            - address_book_duplicate_entry
            - address_book_whitelist_violation
            - rate_limited
            - rate_limit_exceeded
            - internal_error
            - wallet_creation_failed
            - service_temporarily_unavailable
    InsufficientFundsError:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            requestedAmountUsd:
              type: number
              format: double
            grossUsd:
              type: number
              format: double
            encumbrancesUsd:
              type: number
              format: double
            netUsd:
              type: number
              format: double
    WalletWorkflowLeg:
      type: object
      properties:
        status:
          type: string
          enum:
            - created
            - processing
            - pending_customer_approval
            - completed
            - failed
            - cancelled
        from:
          $ref: '#/components/schemas/WalletAccount'
        to:
          $ref: '#/components/schemas/WalletAccount'
        amountUsd:
          type: string
          nullable: true
          description: >-
            USD amount for this workflow leg. Null when no USD value is
            available.
        startedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        stepsCompleted:
          type: integer
        stepsTotal:
          type: integer
        steps:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowStep'
        processingEstimate:
          $ref: '#/components/schemas/ProcessingEstimate'
    AuthErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Authentication or authorization error message.
        message:
          type: string
          nullable: true
          description: Additional auth middleware detail, when present.
        code:
          type: string
          nullable: true
          enum:
            - unauthenticated
            - forbidden
          description: >-
            Some auth and scope failures include a stable code; middleware
            errors may omit it.
    WalletAccount:
      oneOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - yield_source
            id:
              type: string
            label:
              type: string
        - type: object
          properties:
            kind:
              type: string
              enum:
                - cash
            id:
              type: string
            label:
              type: string
        - type: object
          properties:
            kind:
              type: string
              enum:
                - external_payout
            id:
              type: string
            label:
              type: string
        - type: object
          properties:
            kind:
              type: string
              enum:
                - bridge
            id:
              type: string
            label:
              type: string
        - type: object
          properties:
            kind:
              type: string
              enum:
                - unknown
            id:
              type: string
            label:
              type: string
    WorkflowStep:
      type: object
      properties:
        name:
          type: string
        stepKind:
          type: string
          nullable: true
        sequenceRole:
          type: string
          nullable: true
        protocolType:
          type: string
          nullable: true
        stepOrdinal:
          type: integer
        chain:
          type: string
          nullable: true
        txKind:
          type: string
          nullable: true
        state:
          type: string
          enum:
            - created
            - processing
            - pending_customer_approval
            - completed
            - failed
            - cancelled
        startedAt:
          type: string
          format: date-time
          nullable: true
        completedAt:
          type: string
          format: date-time
          nullable: true
        cancelledAt:
          type: string
          format: date-time
          nullable: true
    ProcessingEstimate:
      oneOf:
        - type: object
          required:
            - basis
            - typicalCompletionDate
            - typicalWindowEndDate
          properties:
            basis:
              type: string
              enum:
                - banking_days
            typicalCompletionDate:
              type: string
              format: date
            typicalWindowEndDate:
              type: string
              format: date
        - type: object
          required:
            - basis
            - typicalMinDuration
            - typicalMaxDuration
          properties:
            basis:
              type: string
              enum:
                - elapsed_seconds
            typicalMinDuration:
              type: string
              description: ISO-8601 duration for the lower end of the usual window.
            typicalMaxDuration:
              type: string
              description: ISO-8601 duration for the upper end of the usual window.
  responses:
    Unauthorized:
      description: >-
        The request is missing a valid bearer token, or the token is invalid or
        expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthenticated request
            message: Missing or invalid bearer token
    TooManyRequests:
      description: >-
        Rate limit exceeded. Limits are enforced by API key/customer identity
        and by endpoint class. Retry with backoff; rate-limit headers are not
        currently emitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Rate limit exceeded
            code: rate_limited
    InternalServerError:
      description: >-
        An unexpected error occurred while processing the request. The request
        can be safely retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal server error
            code: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````