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

# Get account balance

> Returns one account with its available balance and the amount currently held for pending outgoing payments.
Responds `404` when the account does not belong to the company or the member cannot access it.




## OpenAPI

````yaml /specs/company.openapi.yaml get /developer/company/accounts/{accountId}
openapi: 3.1.0
info:
  title: Incard Developer API
  version: 0.1.0
  description: OpenAPI definition for the Incard Developer API.
servers:
  - url: https://api.incard.com
    description: Developer Gateway
security:
  - BearerAuth: []
tags:
  - name: ACCOUNTS
    description: Currency accounts and their available balances.
  - name: TRANSACTIONS
    description: Transaction history with filters, pagination, and running balances.
  - name: CARDS
    description: List cards and freeze or unfreeze them.
  - name: INVOICES
  - name: webhooks
paths:
  /developer/company/accounts/{accountId}:
    get:
      tags:
        - ACCOUNTS
      summary: Get account balance
      description: >
        Returns one account with its available balance and the amount currently
        held for pending outgoing payments.

        Responds `404` when the account does not belong to the company or the
        member cannot access it.
      operationId: get_account
      parameters:
        - name: accountId
          in: path
          required: true
          description: Account UUID.
          schema:
            type: string
      responses:
        '200':
          description: The account.
          content:
            application/json:
              schema:
                type: object
                title: AccountDetail
                properties:
                  account:
                    allOf:
                      - $ref: '#/components/schemas/Account'
                      - type: object
                        properties:
                          pending_outgoing:
                            description: >-
                              Absolute amount currently reserved for pending
                              outgoing payments. Already deducted from
                              `balance`.
                            type: number
                        required:
                          - pending_outgoing
                required:
                  - account
              example:
                account:
                  id: 0d6c0a2a-2b08-49bc-89a9-eb936c9ff28c
                  currency_code: GBP
                  name: Main GBP account
                  type: business_transaction
                  created_at: '2025-03-14T10:22:41.000Z'
                  updated_at: '2026-07-02T16:08:11.000Z'
                  provider: currencycloud_gb_cm
                  status: enabled
                  main: true
                  jurisdiction_code: GB
                  funding_accounts:
                    local:
                      account_number: '12345678'
                      account_type: checking
                      name: Incard Ltd
                      address: 1 Example Street, London, EC1A 1AA
                      country_code: GB
                      currency_code: GBP
                      type: regular
                      routing_code_type: sort_code
                      routing_code_value: '040004'
                      bank_name: Example Bank
                    swift: null
                  balance: 4700
                  pending_outgoing: 300
                  pinned: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden — insufficient permission for this user
        '404':
          description: Account not found or not visible to this member.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: Account not found
components:
  schemas:
    Account:
      type: object
      title: Account
      description: A currency account held by the company.
      properties:
        id:
          description: Account UUID. Matches `account_id` on transactions.
          type: string
        currency_code:
          description: ISO 4217 currency of the account.
          type: string
        name:
          description: Account display name.
          type: string
        type:
          description: Account type, for example `business_transaction`.
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        provider:
          description: Underlying banking provider identifier.
          type: string
        status:
          description: Account status, for example `enabled`.
          type: string
        main:
          description: Whether this is the company's main account.
          type: boolean
        jurisdiction_code:
          description: (Optional) ISO 3166-1 alpha-2 jurisdiction the account is held in.
          type:
            - string
            - 'null'
        funding_accounts:
          description: >-
            (Optional) Bank details for paying into the account. Omitted when
            the account has none.
          type: object
          properties:
            local:
              description: Local-rail details, or `null` when unavailable.
              oneOf:
                - $ref: '#/components/schemas/FundingAccount'
                - type: 'null'
            swift:
              description: SWIFT details, or `null` when unavailable.
              oneOf:
                - $ref: '#/components/schemas/FundingAccount'
                - type: 'null'
        balance:
          description: >-
            Available balance in `currency_code` (settled funds minus pending
            outgoing holds). `null` when the balance could not be retrieved.
          type:
            - number
            - 'null'
        pinned:
          description: Whether the member has pinned the account in the dashboard.
          type: boolean
      required:
        - id
        - currency_code
        - name
        - type
        - created_at
        - updated_at
        - provider
        - status
        - main
        - balance
        - pinned
    FundingAccount:
      type: object
      title: FundingAccount
      description: Bank details a payer can use to send money into the account.
      properties:
        account_number:
          description: Account number or IBAN.
          type: string
        account_type:
          description: >-
            Account type as reported by the provider, for example `checking` or
            `iban`.
          type: string
        name:
          description: Account holder name to use on the payment.
          type: string
        address:
          description: Account holder address.
          type: string
        country_code:
          description: ISO 3166-1 alpha-2 country of the bank.
          type: string
        currency_code:
          description: ISO 4217 currency.
          type: string
        type:
          description: '`regular` for local rails, `priority` for SWIFT.'
          type: string
        routing_code_type:
          description: >-
            Routing code scheme, for example `sort_code`, `bic_swift`, or
            `ach_routing_number`.
          type: string
        routing_code_value:
          description: Routing code value.
          type: string
        bank_name:
          description: (Optional) Name of the bank.
          type:
            - string
            - 'null'
      required:
        - account_number
        - account_type
        - name
        - country_code
        - currency_code
        - type
        - routing_code_type
        - routing_code_value
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: access_token
      description: Short-lived access token. Obtain with your api_key.

````