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

# Get merchant USD balance

> Returns the merchant's USD available and reserved balances from Formance. Pending deposits are unconfirmed deposit records and are not spendable ledger balance.



## OpenAPI

````yaml /openapi.json get /v1/balance
openapi: 3.0.3
info:
  contact:
    email: support@yara.cash
    name: Yara API Support
  description: >-
    Merchant-facing wallets/address-as-a-service API for creating merchant
    receive addresses, inspecting balances, quoting transfers, and initiating
    payouts to whitelisted recipients.

    Public endpoints are for external integrators. Dashboard endpoints are
    gateway-to-environment surfaces protected by the external API gateway.
    Internal endpoints are platform/system surfaces protected by an internal
    token.
  license:
    name: Proprietary
  title: Yara External API - Public API
  version: '1.0'
servers:
  - url: https://api.yara.cash
security: []
paths:
  /v1/balance:
    get:
      tags:
        - public.balance
      summary: Get merchant USD balance
      description: >-
        Returns the merchant's USD available and reserved balances from
        Formance. Pending deposits are unconfirmed deposit records and are not
        spendable ledger balance.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BalanceResponse:
      properties:
        data:
          $ref: '#/components/schemas/Balance'
      type: object
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
    Balance:
      properties:
        available:
          example: '1250.500000'
          type: string
        currency:
          example: USD
          type: string
        ledger_timestamp:
          example: '2026-06-16T03:05:00Z'
          type: string
        pending_deposits:
          example: '25.000000'
          type: string
        reserved:
          example: '100.000000'
          type: string
      type: object
    ErrorBody:
      properties:
        code:
          example: validation_error
          type: string
        message:
          example: invalid JSON body
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: 'Public merchant API key. You can also send Authorization: ApiKey <key>.'
      in: header
      name: X-Yara-API-Key
      type: apiKey

````