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

# Get card balance

> A card's balance and how much can be withdrawn.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/card/balance
openapi: 3.1.0
info:
  title: StableMesh Open API
  version: 1.0.0
  description: >-
    Issue and manage StableMesh cards from your own server. Every endpoint is
    `POST` with a JSON body, authenticated with your API key in `X-API-KEY`.
  contact:
    email: contact@stablemesh.io
servers:
  - url: https://api.stablemesh.io
    description: Production
security:
  - ApiKey: []
tags:
  - name: Account
    description: Your USD account.
  - name: Deposits
    description: Fund your USD account with stablecoins.
  - name: Cards
    description: Issue, fund and control cards.
  - name: Webhooks
    description: Configure event delivery.
  - name: Sandbox
    description: Simulate deposits and payments in the sandbox.
paths:
  /v1/card/balance:
    post:
      tags:
        - Cards
      summary: Get card balance
      description: A card's balance and how much can be withdrawn.
      operationId: v1_card_balance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cardId:
                  type: string
                  description: The card's id, from `card/list` or `card/create`.
                  example: '2026100117908000004821'
              required:
                - cardId
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: '`0` on success.'
                    example: 0
                  message:
                    type: string
                    description: '`ok` on success.'
                    example: ok
                  data:
                    $ref: '#/components/schemas/CardBalance'
                required:
                  - code
                  - message
                  - data
        '400':
          description: Refused (bad parameter, business rule). Nothing changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, revoked or expired API key (`11002`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Request from an IP not on the key's allowlist (`11003`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the per-key rate limit (`11004`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Internal error (`9999`). The outcome may be unknown; check state
            before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CardBalance:
      type: object
      properties:
        cardId:
          type: string
          description: The card's id, from `card/list` or `card/create`.
          example: '2026100117908000004821'
        available:
          type: string
          description: Spendable now. Decimal string.
          example: '100'
        frozen:
          type: string
          description: Held. Decimal string.
          example: '0'
        retainedMinimum:
          type: string
          description: Kept on the card by the issuer; can't be withdrawn. Decimal string.
          example: '0'
        maxWithdrawable:
          type: string
          description: '`available - retainedMinimum`, never below 0. Decimal string.'
          example: '100'
        currency:
          type: string
          description: Always `USD`.
          example: USD
      required:
        - cardId
        - available
        - frozen
        - retainedMinimum
        - maxWithdrawable
        - currency
    Error:
      type: object
      properties:
        code:
          type: integer
          description: Non-zero error code. See [Errors](/api-reference/errors).
          example: 4011
        message:
          type: string
          description: Human-readable reason.
          example: >-
            This card can't be topped up through the API. Use the dashboard for
            this card.
        data:
          type: object
          description: >-
            Present only when the error carries something you need, e.g.
            `withdrawalId` on a `9999` from `card/withdraw`.
          additionalProperties: true
      required:
        - code
        - message
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Create keys in the dashboard under **Settings → API keys**. Production
        keys start with `smk_live_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.