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

# Update a wallet

> Update a wallet's mutable presentation fields. Only `label` is mutable; send an empty string to clear it. Serves both fiat (`wlt_fiat_`) and custodial (`wlt_`) ids, matching `getWallet`.



## OpenAPI

````yaml /api-reference/openapi.yaml patch /wallets/{id}
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.09.09-0001
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.13
    description: Sandbox
  - url: https://api.polygon.technology/v0.13
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via FrontEgg
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: VirtualAccount
  - name: Counterparty
  - name: ExternalAccount
  - name: Reference
  - name: DepositAddress
paths:
  /wallets/{id}:
    patch:
      tags:
        - Wallet
      summary: Update a wallet
      description: >-
        Update a wallet's mutable presentation fields. Only `label` is mutable;
        send an empty string to clear it. Serves both fiat (`wlt_fiat_`) and
        custodial (`wlt_`) ids, matching `getWallet`.
      operationId: updateWallet
      parameters:
        - name: id
          in: path
          required: true
          description: Wallet ID (`wlt_` prefix; `wlt_fiat_` also accepted).
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletUpdateRequest'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletResource'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidWalletIDErrorResponse'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletNotFoundErrorResponse'
        '409':
          description: The request conflicts with the current state of the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionConflictErrorResponse'
        '422':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyUpdateErrorResponse'
components:
  schemas:
    WalletUpdateRequest:
      type: object
      properties:
        label:
          type: string
          description: Optional display label. An empty string clears the label.
      description: >-
        Partial update for a wallet (fiat or custodial) — only `label` is
        mutable. Send an empty string to clear an existing label; omit the field
        to leave it unchanged.
    WalletResource:
      type: object
      oneOf:
        - $ref: '#/components/schemas/WalletResourceCustodial'
        - $ref: '#/components/schemas/WalletResourceFiat'
      discriminator:
        propertyName: type
        mapping:
          custodial:
            $ref: '#/components/schemas/WalletResourceCustodial'
          fiat:
            $ref: '#/components/schemas/WalletResourceFiat'
      description: >-
        A wallet OMS manages for a customer. `type` discriminates the variant
        and the variant-specific fields live in `details`: `custodial` holds one
        crypto asset on one network at the custody provider ("Coinme Inc."
        today); `fiat` holds a single fiat currency balance (only `usd` today)
        on an internal ledger at "Erebor Bank, N.A." — no network and no
        on-chain address. There is no `embedded` variant in the response: a
        request for one is rejected with 501 `walletTypeNotSupported`. Read
        `type` for logic rather than parsing the id.
    InvalidWalletIDErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - InvalidWalletID
        code:
          type: number
          enum:
            - 10138
        msg:
          type: string
          enum:
            - invalid source fiat wallet id
        cause:
          type: string
    WalletNotFoundErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - WalletNotFound
        code:
          type: number
          enum:
            - 10015
        msg:
          type: string
          enum:
            - fiat wallet not found
        cause:
          type: string
    VersionConflictErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - VersionConflict
        code:
          type: number
          enum:
            - 10069
        msg:
          type: string
          enum:
            - counterparty was modified concurrently
        cause:
          type: string
    EmptyUpdateErrorResponse:
      type: object
      required:
        - error
        - code
        - msg
      properties:
        error:
          type: string
          enum:
            - EmptyUpdate
        code:
          type: number
          enum:
            - 10019
        msg:
          type: string
          enum:
            - at least one field must be provided (label or metadata)
        cause:
          type: string
    WalletResourceCustodial:
      type: object
      required:
        - id
        - object
        - customerId
        - status
        - provider
        - multiAsset
        - displayName
        - type
        - details
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: Wallet ID (TypeID; `wlt_fiat_` for fiat wallets).
        object:
          type: string
          enum:
            - wallet
          description: Resource type discriminator. Always "wallet".
        customerId:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: The OMS customer that owns this record (`cst_` prefix).
        customer:
          allOf:
            - $ref: '#/components/schemas/CustomerSummary'
          description: >-
            Display-safe summary of the owning customer (`customer.id` equals
            `customerId`). Returned on list and detail responses.
        status:
          allOf:
            - $ref: '#/components/schemas/WalletResourceStatus'
          description: Current wire status.
        provider:
          type: string
          description: >-
            The legal entity holding this wallet's assets, derived from wallet
            type and asset: `custodial` → "Coinme Inc."; `fiat` (usd) → "Erebor
            Bank, N.A.". New providers may be added, so treat the string as
            free-form rather than a fixed set.
        multiAsset:
          type: boolean
          description: >-
            true when the wallet supports every network in its family and all
            assets on them; false when restricted to a single asset (fiat,
            custodial).
        displayName:
          type: string
          description: >-
            Server-generated wallet name. Custodial wallets use their on-chain
            address; fiat wallets use `USD balance (<wallet id>)`. Distinct from
            the optional partner-supplied label.
        label:
          type: string
          nullable: true
        balances:
          type: array
          items:
            $ref: '#/components/schemas/WalletResourceBalance'
        metadata:
          type: object
          additionalProperties:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        type:
          type: string
          enum:
            - custodial
          description: Type discriminator.
        details:
          $ref: '#/components/schemas/WalletDetailCustodial'
      description: >-
        The `custodial` variant — one crypto asset on one network, held on the
        customer's behalf by the custody provider, currently "Coinme Inc.".
        `details.address` is the on-chain deposit address and is omitted until
        the provider reports one.
    WalletResourceFiat:
      type: object
      required:
        - id
        - object
        - customerId
        - status
        - provider
        - multiAsset
        - displayName
        - type
        - details
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: Wallet ID (TypeID; `wlt_fiat_` for fiat wallets).
        object:
          type: string
          enum:
            - wallet
          description: Resource type discriminator. Always "wallet".
        customerId:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: The OMS customer that owns this record (`cst_` prefix).
        customer:
          allOf:
            - $ref: '#/components/schemas/CustomerSummary'
          description: >-
            Display-safe summary of the owning customer (`customer.id` equals
            `customerId`). Returned on list and detail responses.
        status:
          allOf:
            - $ref: '#/components/schemas/WalletResourceStatus'
          description: Current wire status.
        provider:
          type: string
          description: >-
            The legal entity holding this wallet's assets, derived from wallet
            type and asset: `custodial` → "Coinme Inc."; `fiat` (usd) → "Erebor
            Bank, N.A.". New providers may be added, so treat the string as
            free-form rather than a fixed set.
        multiAsset:
          type: boolean
          description: >-
            true when the wallet supports every network in its family and all
            assets on them; false when restricted to a single asset (fiat,
            custodial).
        displayName:
          type: string
          description: >-
            Server-generated wallet name. Custodial wallets use their on-chain
            address; fiat wallets use `USD balance (<wallet id>)`. Distinct from
            the optional partner-supplied label.
        label:
          type: string
          nullable: true
        balances:
          type: array
          items:
            $ref: '#/components/schemas/WalletResourceBalance'
        metadata:
          type: object
          additionalProperties:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        type:
          type: string
          enum:
            - fiat
          description: Type discriminator.
        details:
          $ref: '#/components/schemas/WalletDetailFiat'
      description: >-
        The `fiat` variant — a single fiat currency balance (only `usd` today)
        held at a partner bank, currently "Erebor Bank, N.A.". An internal
        ledger balance: no network and no on-chain address.
    typeId:
      type: string
      pattern: >-
        ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
      description: >-
        Public TypeID, e.g. `txn_01h455vb4pex5vsknk084sn02q`; legacy UUID
        suffixes are accepted until non-v7 rows are retired.
      x-go-type: string
    CustomerSummary:
      type: object
      required:
        - id
        - name
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/typeId'
          description: The OMS customer id (`cst_` prefix).
        name:
          type: string
          description: Customer display name.
      description: >-
        Display-safe summary of a customer — ID plus display name only. Enables
        one-request list rendering: a page of rows needs no per-row detail
        queries. Always the record's owning customer, not whichever side a party
        sits on.
    WalletResourceStatus:
      type: string
      enum:
        - preallocated
        - active
        - suspended
      description: >-
        `preallocated`: reserved/provisioned but not yet activated. `active`:
        usable. `suspended`: temporarily disabled (e.g. a compliance or risk
        hold). There is no terminal value — a closed wallet also reports
        `suspended`.
    WalletResourceBalance:
      type: object
      required:
        - asset
        - network
        - balance
        - estimatedValueUsd
      properties:
        asset:
          type: string
        network:
          type: string
          nullable: true
          description: Null for fiat balances — held on an internal ledger, not a network.
        balance:
          $ref: '#/components/schemas/signedFixedDecimalString'
        estimatedValueUsd:
          $ref: '#/components/schemas/signedFixedDecimalString'
      description: >-
        One (asset, network) balance entry on a wallet. The OMS contract calls
        this `WalletBalance`; renamed here because the legacy balance-response
        envelope owns that name.
    WalletDetailCustodial:
      type: object
      required:
        - network
        - asset
      properties:
        network:
          type: string
          description: >-
            Blockchain network the wallet operates on (canonical name, e.g.
            "polygon").
        asset:
          type: string
          description: Crypto asset the wallet holds (canonical symbol, e.g. "usdc").
        address:
          type: string
          description: >-
            On-chain deposit address. Omitted when the provider has not reported
            one yet.
      description: >-
        Custodial crypto wallet details — one asset on one network, held by the
        custody provider on the customer's behalf.
    WalletDetailFiat:
      type: object
      required:
        - asset
      properties:
        asset:
          type: string
          enum:
            - usd
          description: Fiat currency of the balance. Only `usd` today.
      description: >-
        Fiat wallet details — a single fiat currency balance held at a partner
        bank (internal ledger, no network or on-chain address).
    signedFixedDecimalString:
      type: string
      description: >-
        Wire-safe decimal string for signed financial values that must ship with
        a fixed scale (trailing zeros preserved). It combines the two guarantees
        the OMS `Customer.totalBalance` fields need at once: the leading minus
        is part of the contract — a fiat balance may be negative after an ACH
        clawback, so consumers render the sign as-is and never clamp to zero —
        and the scale is preserved on the wire (e.g. `"25.00"`, `"-25.00"`,
        `"0.00"`), unlike `signedDecimalString`/`decimal.Decimal`, whose
        `.String()` trims trailing zeros (`"25.00"` → `"25"`). Same underlying
        `numeric.FixedDecimalString` Go type as `fixedDecimalString`; the
        builder is responsible for setting the scale (via `StringFixed`).
      x-go-type-import:
        path: github.com/0xPolygon/bpn-lib/numeric
      x-go-type: numeric.FixedDecimalString
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````