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

# Get Balance Details

> Retrieve detailed information on the various balance types available for transactions in your account. This API provides insights into different balances, which help in tracking funds across distinct states. The following balance types are included:

- `available_balance`: The amount currently available for any transaction, representing funds that can be used immediately.
- `incoming_balance`: Funds that are in the process of being credited from successful payments but are yet to be paid out by the third-party provider (e.g., credit card processor).
- `outgoing_balance`: Funds that are pending deduction from the available balance, set aside to process future actions such as refunds, disputes, or payouts.
- `rolling_reserve_balance`: A reserved amount held as a buffer by the merchant; typically used for security against chargebacks or other potential liabilities. This is an optional feature that can be activated by contacting technical support.
- `withdrawable_balance`: The portion of the available balance that can be withdrawn, which excludes rolling reserve funds.

**Note**: This API currently supports only AUD (Australian Dollar) balances. Support for additional currencies is under development.




## OpenAPI

````yaml /api/openapi/v1-reference.yaml get /v1/balances/detail
openapi: 3.0.3
info:
  title: Payment APIs (AUD only)
  description: >-
    ## Introduction

    The Payment API Solution (AUD) offers developers a comprehensive suite of
    API services to build innovative AUD payment solutions efficiently. These
    APIs enable seamless transactions using various payment methods and
    functionalities, ensuring a robust, reliable, and scalable payment
    infrastructure tailored for the Australian market.

    ### Key Features

    - **Payment Methods**:
      - **Payment Link**: Supports payments via card and PayID.
      - **PayID**: Provides instant payments using a unique identifier.
      - **PayTo**: Enables scheduled or recurring payments.
      - **BSB/Account Number**: Allows direct bank transfers.
      - **Payout**: Manage payouts to designated accounts.

    - **Additional Functionalities**:
      - **Balance Management**: Real-time balance inquiries and updates.
      - **Reporting Services**: Generate detailed transaction and payment reports.

    This documentation provides detailed guidance for integrating these
    capabilities into your application.
  termsOfService: https://helloclever.co/terms
  contact:
    email: support@helloclever.co
  version: 1.0.11
servers:
  - url: https://api.cleverhub.co/api
    description: Sandbox Environment
  - url: https://api-merchant.helloclever.co/api
    description: Production Environment
security: []
paths:
  /v1/balances/detail:
    get:
      tags:
        - Balance
      summary: Get Balance Details
      description: >
        Retrieve detailed information on the various balance types available for
        transactions in your account. This API provides insights into different
        balances, which help in tracking funds across distinct states. The
        following balance types are included:


        - `available_balance`: The amount currently available for any
        transaction, representing funds that can be used immediately.

        - `incoming_balance`: Funds that are in the process of being credited
        from successful payments but are yet to be paid out by the third-party
        provider (e.g., credit card processor).

        - `outgoing_balance`: Funds that are pending deduction from the
        available balance, set aside to process future actions such as refunds,
        disputes, or payouts.

        - `rolling_reserve_balance`: A reserved amount held as a buffer by the
        merchant; typically used for security against chargebacks or other
        potential liabilities. This is an optional feature that can be activated
        by contacting technical support.

        - `withdrawable_balance`: The portion of the available balance that can
        be withdrawn, which excludes rolling reserve funds.


        **Note**: This API currently supports only AUD (Australian Dollar)
        balances. Support for additional currencies is under development.
      operationId: getBalanceDetails
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  available_balance:
                    type: number
                    description: >-
                      The balance available for any transaction or immediate
                      use.
                    example: 1000.5
                  incoming_balance:
                    type: number
                    description: >-
                      Funds from payments that are in transit and not yet
                      available for spending.
                    example: 500.25
                  outgoing_balance:
                    type: number
                    description: >-
                      Amounts earmarked for pending transactions, such as
                      refunds or payouts, that will reduce the available balance
                      once processed.
                    example: 250.75
                  rolling_reserve_balance:
                    type: number
                    description: >-
                      A reserve amount held for potential liabilities, such as
                      chargebacks; may vary based on business risk.
                    example: 1500
                  withdrawable_balance:
                    type: number
                    description: >-
                      The amount eligible for withdrawal, excluding any rolling
                      reserve amounts.
                    example: 850.3
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
        - app-id: []
          secret-key: []
components:
  securitySchemes:
    app-id:
      type: apiKey
      in: header
      name: app-id
      description: |
        A unique identifier assigned to each application.
    secret-key:
      type: apiKey
      in: header
      name: secret-key
      description: |
        A secure token associated with the `app-id`.

````

## Related topics

- [Balance API Reference (v2)](/api/v2/balance.md)
- [AUD Balance API Reference](/api/v1/balance.md)
- [Get Balance Details V2](/api/balance/get-balance-details-v2.md)
