# Get Balance

Returns the consolidated and detailed wallet snapshot across all banking partners (Delbank, Celcoin, StarkBank).

Two account types are tracked per bank:
- Transactional — funds available to cover Cash-Out requests (mirrors your users' exposure)
- Proprietary — reserve/buffer account (your operational capital)

> ℹ️ Note: Historical balance lookup (?date=) is currently in development. Only the current balance is available.

Endpoint: GET /account/balance
Version: 2.0.0
Security: bearerAuth

## Header parameters:

  - `ApplicationToken` (string, required)
    Fixed GUID that uniquely identifies your integration. Provided during ConnectPSP onboarding.
    Example: "{{ApplicationToken}}"

## Query parameters:

  - `date` (string)
    Date for historical balance snapshot (ISO 8601 — YYYY-MM-DD). Currently not available.
    Example: "2026-03-10"

## Response 200 fields (application/json):

  - `currency` (string)
    Example: "BRL"

  - `referenceDate` (string)
    Example: "2026-03-10"

  - `consolidated` (object)

  - `consolidated.totalBalance` (number)
    Sum of all transactional and proprietary balances.
    Example: 1500000

  - `consolidated.transactionalBalance` (number)
    Total funds available for Cash-Out operations.
    Example: 500000

  - `consolidated.proprietaryBalance` (number)
    Total reserve/buffer capital.
    Example: 1000000

  - `banks` (array)

  - `banks.ispb` (string)
    Example: "13935893"

  - `banks.bank` (string)
    Example: "CELCOIN IP S.A."

  - `banks.accounts` (object)

  - `banks.accounts.transactional` (object)

  - `banks.accounts.transactional.branch` (string)
    Example: "0001"

  - `banks.accounts.transactional.account` (string)
    Example: "123456"

  - `banks.accounts.transactional.balance` (number)
    Example: 200000

  - `banks.accounts.proprietary` (object)

  - `updatedAt` (string)
    Timestamp when the balance snapshot was extracted.
    Example: "2026-03-10T14:35:00Z"

## Response 401 fields (application/problem+json):

  - `type` (string)
    URI identifying the error type.
    Example: "https://connect-psp.redocly.app/errors/insufficient-funds"

  - `title` (string)
    Short, human-readable summary.
    Example: "Insufficient Funds"

  - `status` (integer)
    HTTP status code.
    Example: 422

  - `code` (string)
    Machine-readable error code for programmatic handling.
    Example: "INSUFFICIENT_FUNDS"

  - `detail` (string)
    Human-readable explanation of this specific occurrence.
    Example: "The requested amount of R$ 500.00 exceeds available balance of R$ 100.00."

## Response 422 fields (application/problem+json):

  - `type` (string)
    URI identifying the error type.
    Example: "https://connect-psp.redocly.app/errors/insufficient-funds"

  - `title` (string)
    Short, human-readable summary.
    Example: "Insufficient Funds"

  - `status` (integer)
    HTTP status code.
    Example: 422

  - `code` (string)
    Machine-readable error code for programmatic handling.
    Example: "INSUFFICIENT_FUNDS"

  - `detail` (string)
    Human-readable explanation of this specific occurrence.
    Example: "The requested amount of R$ 500.00 exceeds available balance of R$ 100.00."