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

# Get account balance

> Retrieves the account financial position including total asset value, liabilities, and net available balance. Use `GET /accounts/:id/assets` for per-asset breakdown. All values are in the project's billing currency (see the `currency` field).



## OpenAPI

````yaml /api-reference/openapi.json get /accounts/{id}/balance
openapi: 3.1.0
info:
  title: Reap API
  version: 1.0.0
  description: Reap platform API
servers:
  - url: https://sandbox.api.reap.global
    description: Sandbox
  - url: https://prod.api.reap.global
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Accounts
  - name: Activities
  - name: Card Designs
  - name: Card Shipments
  - name: Card Transactions
  - name: Cards
  - name: Companies
  - name: Crypto Deposits
  - name: Policies
  - name: Simulation
  - name: Users
  - name: Virtual Asset Postings
  - name: Virtual Assets
  - name: Webhooks
paths:
  /accounts/{id}/balance:
    get:
      tags:
        - Accounts
      summary: Get account balance
      description: >-
        Retrieves the account financial position including total asset value,
        liabilities, and net available balance. Use `GET /accounts/:id/assets`
        for per-asset breakdown. All values are in the project's billing
        currency (see the `currency` field).
      operationId: getBalance_accounts
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Account ID
        - name: Reap-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-02-14'
            description: API version (YYYY-MM-DD)
            example: '2025-02-14'
      responses:
        '200':
          description: >-
            Account balance: total asset value, liabilities, and net position.
            In User-Funded projects and Program-Funded projects on Managed
            authorization, Reap authorizes each card transaction against these
            balances. Under External authorization this endpoint is not the
            authorization source: Reap holds no per-user asset balance,
            `availableBalance` reflects only Reap-side card debt and is not
            spendable, and your own ledger is authoritative.
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    examples:
                      - USD
                      - HKD
                    description: >-
                      Currency for all monetary values - the billing currency of
                      the project's card program
                  totalAssetValue:
                    type: number
                    minimum: 0
                    examples:
                      - 5000
                    description: Sum of all asset values backing the account.
                  totalLiabilities:
                    type: number
                    examples:
                      - 500
                      - 0
                      - -25
                    description: >-
                      Sum of all liabilities. Can be negative when refunds or
                      settlement payments exceed outstanding card debt.
                  availableBalance:
                    type: number
                    examples:
                      - 4500
                    description: >-
                      Net balance: `totalAssetValue - totalLiabilities`. In
                      User-Funded projects and Program-Funded projects on
                      Managed authorization, this is the spendable figure the
                      next card swipe is authorized against and the primary
                      number to surface to cardholders. Not a spendable figure
                      under External authorization - see the endpoint
                      description.
                  assets:
                    $ref: '#/components/schemas/BalanceAssets'
                    description: >-
                      Breakdown of asset categories contributing to
                      totalAssetValue
                  liabilities:
                    $ref: '#/components/schemas/BalanceLiabilities'
                    description: >-
                      Breakdown of liability categories contributing to
                      totalLiabilities
                required:
                  - currency
                  - totalAssetValue
                  - totalLiabilities
                  - availableBalance
                  - assets
                  - liabilities
        '404':
          description: Account not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: ACCOUNT_NOT_FOUND
                      message:
                        type: string
                      detail:
                        anyOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                    required:
                      - code
                      - message
                      - detail
                required:
                  - error
                title: AccountNotFoundError
components:
  schemas:
    BalanceAssets:
      type: object
      properties:
        crypto:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
          examples:
            - 5000
          description: >-
            Value of on-chain crypto wallet holdings, in the response currency.
            Null for accounts without provisioned wallets (user accounts on
            `PROGRAM_FUNDED` projects).
        virtual:
          anyOf:
            - type: number
              minimum: 0
            - type: 'null'
          examples:
            - 2000
          description: >-
            Value of virtual asset balances on this account, in the response
            currency. Null when virtual assets are not applicable to the
            project.
      required:
        - crypto
        - virtual
    BalanceLiabilities:
      type: object
      properties:
        cardDebt:
          $ref: '#/components/schemas/CardDebt'
      required:
        - cardDebt
    CardDebt:
      type: object
      properties:
        pending:
          type: number
          examples:
            - 50
            - 0
          description: Authorized card spend not yet cleared. Reduces available balance.
        cleared:
          type: number
          examples:
            - 450
            - 0
            - -25
          description: >-
            Cleared card debt - real receivable. Drained by sweep (Direct) or
            settlement posting (Prefund). May be negative when over-settled.
        total:
          type: number
          examples:
            - 500
            - 0
            - -25
          description: Total outstanding card debt (`pending + cleared`).
      required:
        - pending
        - cleared
        - total
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token

````