> ## 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.

# Create a portfolio wallet

> Creates a new wallet with token-keyed strategy allocations. Each included stablecoin group must sum to 100 percent. Idempotent on `requestId` — if a wallet with the same `requestId` already exists, the existing wallet is returned. Always returns `200`; newly created wallets are returned with `status: creating` while they provision.



## OpenAPI

````yaml swagger/swagger-combined.yaml POST /v2/wallets
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:
    post:
      tags:
        - Portfolio Wallets
      summary: Create a Wallet
      description: >-
        Creates a new wallet with token-keyed strategy allocations. Each
        included stablecoin group must sum to 100 percent. Idempotent on
        `requestId` — if a wallet with the same `requestId` already exists, the
        existing wallet is returned. Always returns `200`; newly created wallets
        are returned with `status: creating` while they provision.
      operationId: createWalletV2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - requestId
                - strategy
              additionalProperties: false
              properties:
                requestId:
                  type: string
                  format: uuid
                  description: Client-generated idempotency key (UUID v4).
                label:
                  type: string
                  nullable: true
                  description: Optional human-readable label for the wallet.
                strategy:
                  $ref: '#/components/schemas/StrategyInput'
            example:
              requestId: a1b2c3d4-0000-4000-8000-000000000001
              label: Corporate Treasury
              strategy:
                allocations:
                  usdc:
                    - yieldSourceId: cash
                      pct: 20
                    - yieldSourceId: morpho-gauntlet-usdc
                      pct: 80
                  usdt:
                    - yieldSourceId: cash
                      pct: 100
      responses:
        '200':
          description: >-
            Wallet returned. New wallets may still be provisioning with `status:
            creating`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wallet'
              example:
                id: b1c2d3e4-0000-4000-8000-000000000001
                label: Corporate Treasury
                createdAt: '2025-09-01T00:00:00Z'
                status: creating
                failureReason: null
                depositAddresses: {}
                balance:
                  totalUsd: '0.000000'
                  withdrawableUsd: '0.000000'
                  reservedUsd: '0.000000'
                  earnedUsd: '0.000000'
                positions: []
                strategyAllocations:
                  usdc:
                    - yieldSourceId: cash
                      targetWeightBps: 2000
                      token: usdc
                    - yieldSourceId: morpho-gauntlet-usdc
                      targetWeightBps: 8000
                  usdt:
                    - yieldSourceId: cash
                      targetWeightBps: 10000
                      token: usdt
                      chain: ethereum
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_allocation:
                  summary: Allocations do not sum to 100
                  value:
                    error: Allocation percentages must sum to 100
                    code: validation_error
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: >-
            The same `requestId` was reused with a divergent payload
            (`request_id_conflict`). An identical replay returns `200` with the
            existing wallet instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                request_id_conflict:
                  summary: requestId reused with a different wallet payload
                  value:
                    error: requestId has already been used with a different payload
                    code: request_id_conflict
                duplicate_request_id:
                  summary: Concurrent create race on the same requestId
                  value:
                    error: Duplicate requestId
                    code: duplicate_request_id
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          description: Upstream wallet-creation failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                wallet_creation_failed:
                  value:
                    error: Turnkey wallet creation failed
                    code: wallet_creation_failed
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    StrategyInput:
      type: object
      required:
        - allocations
      additionalProperties: false
      properties:
        allocations:
          $ref: '#/components/schemas/TokenStrategyAllocationsInput'
    Wallet:
      type: object
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        status:
          type: string
          description: Compact wallet lifecycle and active-workflow status.
          enum:
            - creating
            - idle
            - withdrawal_active
            - rebalance_active
            - withdrawal_and_rebalance_active
            - failed
        failureReason:
          type: string
          nullable: true
        depositAddresses:
          type: object
          description: Deposit addresses keyed by chain name.
          additionalProperties:
            type: string
          example:
            arbitrum: '0xAbC1230000000000000000000000000000000001'
            base: '0xAbC1230000000000000000000000000000000001'
            ethereum: '0xAbC1230000000000000000000000000000000001'
            polygon: '0xAbC1230000000000000000000000000000000001'
            solana: 7vFgKxM3bP4oEFbqkPmA5E2rYJ8HqKz8abc1
        balance:
          type: object
          properties:
            totalUsd:
              type: string
              description: >-
                Gross economically owned wallet value across cash, positions,
                and in-transit customer-owned value.
            withdrawableUsd:
              type: string
              description: >-
                Conservative amount that can be initiated for withdrawal now,
                excluding active withdrawal encumbrances and unavailable
                transit.
            reservedUsd:
              type: string
              description: Customer-owned value reserved by active wallet workflows.
            earnedUsd:
              type: string
              description: >-
                Customer-facing lifetime realized gross yield earned to date,
                before explicit protocol fees and protocol slippage.
        positions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: >-
                  Public account/position id. Yield positions use yield source
                  ids; cash positions use stable synthetic ids.
              kind:
                type: string
                enum:
                  - yield_source
                  - cash
                  - bridge
                  - external_payout
                  - unknown
              label:
                type: string
                description: Human-readable display name.
              valueUsd:
                type: string
                description: Current USD value of this position.
              pct:
                type: number
                description: >-
                  Target allocation percentage. Present on yield positions and
                  configured cash allocations; omitted on unconfigured synthetic
                  positions.
              yieldSourceId:
                type: string
                description: >-
                  Stable public yield source id. Present for yield-source
                  positions.
              token:
                $ref: '#/components/schemas/PortfolioWalletStrategyToken'
              chain:
                type: string
                description: >-
                  Chain for a cash position. Omitted from yield-source
                  positions; use the matching yield-source catalog row for its
                  chain.
        strategyAllocations:
          $ref: '#/components/schemas/PublicStrategyAllocationGroups'
    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
    TokenStrategyAllocationsInput:
      type: object
      minProperties: 1
      additionalProperties: false
      properties:
        usdc:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/AllocationInput'
          description: USDC-compatible allocations. Percentages must sum to 100.
        usdt:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/AllocationInput'
          description: USDT-compatible allocations. Percentages must sum to 100.
      description: >-
        Token-keyed allocation groups. Each included token lane must
        independently sum to 100 percent.
    PortfolioWalletStrategyToken:
      type: string
      enum:
        - usdc
        - usdt
      description: >-
        Stablecoin lane used to validate, fund, rebalance, and withdraw an
        allocation independently from other token lanes.
    PublicStrategyAllocationGroups:
      type: object
      properties:
        usdc:
          type: array
          items:
            $ref: '#/components/schemas/PublicStrategyAllocation'
        usdt:
          type: array
          items:
            $ref: '#/components/schemas/PublicStrategyAllocation'
      description: >-
        Desired strategy targets grouped by stablecoin. Each returned group uses
        basis-point weights that sum to 10000.
    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.
    ServiceUnavailableError:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retryable:
              type: boolean
              description: Whether the client should retry with the same requestId
    AllocationInput:
      type: object
      required:
        - yieldSourceId
        - pct
      additionalProperties: false
      properties:
        yieldSourceId:
          $ref: '#/components/schemas/PortfolioWalletYieldSourceId'
        pct:
          type: number
          multipleOf: 0.1
          minimum: 0
          maximum: 100
          description: >-
            Percentage of the token lane to allocate to this yield source or to
            cash when `yieldSourceId` is `cash`. Supports 0.1% increments.
    PublicStrategyAllocation:
      type: object
      required:
        - yieldSourceId
        - targetWeightBps
      properties:
        yieldSourceId:
          $ref: '#/components/schemas/PortfolioWalletYieldSourceId'
        targetWeightBps:
          type: integer
          minimum: 0
          maximum: 10000
          description: Target weight within this token lane, in basis points.
        token:
          $ref: '#/components/schemas/PortfolioWalletStrategyToken'
        chain:
          type: string
          description: Chain for a chain-scoped cash target.
    PortfolioWalletYieldSourceId:
      type: string
      description: >-
        Stable yield source ID from `GET /v2/wallets/yield-sources`, or the
        special `cash` id for cash held in the allocation's token lane. The live
        yield source catalog is environment-specific; fetch it before creating
        or updating a yield allocation.
  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
    ServiceUnavailable:
      description: >-
        An upstream dependency is temporarily unavailable. The request can be
        retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceUnavailableError'
          example:
            error: Service temporarily unavailable
            code: service_temporarily_unavailable
            retryable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````