> ## 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 History

> Access a detailed history of balance transactions over a specified date range. This includes all balance changes in your account, such as incoming payments, refunds, top-ups, and other transactions. Use this endpoint to gain a comprehensive view of how balance values fluctuate due to account activity.

**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/history
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/history:
    get:
      tags:
        - Balance
      summary: Get Balance History
      description: >
        Access a detailed history of balance transactions over a specified date
        range. This includes all balance changes in your account, such as
        incoming payments, refunds, top-ups, and other transactions. Use this
        endpoint to gain a comprehensive view of how balance values fluctuate
        due to account activity.


        **Note**: This API currently supports only AUD (Australian Dollar)
        balances. Support for additional currencies is under development.
      operationId: getBalanceHistory
      parameters:
        - in: query
          name: from_date
          schema:
            type: string
            format: date-time
            example: '2022-01-01T00:00:00Z'
          description: >-
            Start date for querying balance history in the format
            'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.
        - in: query
          name: to_date
          schema:
            type: string
            format: date-time
            example: '2022-01-31T23:59:59Z'
          description: >-
            End date for querying balance history in the format
            'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone.
        - in: query
          name: page
          schema:
            type: integer
          description: >-
            The page number of the balance history results, for pagination
            purposes.
        - in: query
          name: size
          schema:
            type: integer
          description: Number of records to display per page in the paginated response.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  from_date:
                    type: string
                    format: date-time
                    description: The start date for the balance history retrieved.
                    example: '2022-01-01T00:00:00Z'
                  to_date:
                    type: string
                    format: date-time
                    description: The end date for the balance history retrieved.
                    example: '2022-01-31T23:59:59Z'
                  page:
                    type: integer
                    description: The current page number of the response.
                    example: 1
                  size:
                    type: integer
                    description: The number of records returned per page.
                    example: 20
                  next_page:
                    type: integer
                    description: The page number of the next set of results, if available.
                    example: 2
                  total_page:
                    type: integer
                    description: The total number of pages in the response.
                    example: 10
                  total_count:
                    type: integer
                    description: The total number of records available across all pages.
                    example: 200
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the balance transaction.
                          example: txn_01F8R97A2P9A9
                        amount:
                          type: number
                          description: The amount associated with the transaction.
                          example: 150.75
                        request_type:
                          type: string
                          enum:
                            - money_out
                            - money_in
                          description: >-
                            Type of transaction, indicating if funds are being
                            credited or debited.
                          example: money_in
                        transaction_type:
                          type: string
                          enum:
                            - payment
                            - settlement
                            - refund
                            - topup
                            - dispute
                            - eod_settlement
                            - dispute_fee
                            - payout
                            - payout_refund
                          description: >-
                            The specific type of transaction affecting the
                            balance.
                          example: payment
                        currency:
                          type: string
                          description: Currency code for the transaction.
                          example: AUD
                        payment_method:
                          type: string
                          enum:
                            - bsb
                            - card
                            - pay_id
                            - pay_to
                          description: Method used for the transaction.
                          example: card
                        status:
                          type: string
                          enum:
                            - waiting
                            - done
                            - failed
                          description: Status of the transaction.
                          example: done
                        reference_id:
                          type: string
                          description: A unique reference identifier for the transaction.
                          example: ref_01F8R97A2P9A9
                        balance_detail:
                          type: object
                          properties:
                            outgoing:
                              type: number
                              description: >-
                                Amount being deducted or processed in the
                                transaction.
                              example: 120
                            total:
                              type: number
                              description: >-
                                Total transaction amount, which may include
                                fees.
                              example: 130
                            fees:
                              type: number
                              description: Fees applied to the transaction.
                              example: 10
                        created_at:
                          type: string
                          format: date-time
                          description: >-
                            The timestamp indicating when the transaction was
                            created (UTC).
                          example: '2022-01-15T12:30:00Z'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Entity
      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

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