> ## 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 V2 > 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. ## OpenAPI ````yaml /api/openapi/v2-reference.yaml get /v2/balances/history openapi: 3.0.2 info: title: Multi-currency Payment APIs description: >- ## Introduction The Multi-currency Payment API Solution provides developers with a unified API schema to support multiple currencies efficiently. These APIs enable seamless transactions for both payin and payout operations, ensuring a robust, reliable, and scalable payment infrastructure for businesses dealing with various currencies. ### Key Features - **Single API Schema**: A single schema supports all currencies in your account, simplifying integration and management. - **Payin and Payout Process**: - **Step 1**: Call the **Get payin method list** to retrieve the list of supported methods. - **Step 2**: Call the **Get payin required fields** to get specific required fields for each method. - **Step 3**: Create the payment using the method and required fields from the previous step. - **Step 4**: On the sandbox environment, you can call the **Simulate payin** to simulate the payment.
Please note: GST should only be set to true for AU Merchants for AUD currency only. For all other currencies, set GST to false.
This documentation provides detailed guidance for integrating these capabilities into your application. version: 2.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: - app-id: [] secret-key: [] paths: /v2/balances/history: get: tags: - Balance summary: Get Balance History V2 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. operationId: getBalanceHistory parameters: - name: from_date in: query required: true schema: type: string format: date-time description: >- Start date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone. example: '2026-01-01T00:00:00Z' - name: to_date in: query required: true schema: type: string format: date-time description: >- End date for querying balance history in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone. example: '2026-01-31T00:00:00Z' - name: cursor in: query schema: type: string description: >- Pagination cursor returned as `next_cursor` in the previous response. Omit this parameter to fetch the first page. example: eyJpZCI6ImJsX3BpX3duNFRXaGxYQnJaSyJ9 - name: size in: query schema: type: integer default: 20 description: Number of records to return per page. responses: '200': description: OK content: application/json: schema: type: object properties: from_date: type: string example: '2026-01-01T00:00:00Z' to_date: type: string example: '2026-01-31T00:00:00Z' account_type: type: string description: The type of the requesting account. example: aggregated enum: - aggregated - dedicated size: type: integer example: 20 description: Number of records returned per page. next_cursor: type: string nullable: true example: eyJpZCI6ImJsX3BpX3duNFRXaGxYQnJaSyJ9 description: >- Cursor to pass as the `cursor` query parameter to fetch the next page. `null` when there are no more records. has_more: type: boolean example: true description: Whether more records are available after this page. records: type: array items: type: object properties: id: type: string example: bl_pi_wn4TWhlXBrZK description: Balance Id amount: type: number example: 202.66 description: Amount of a transaction charged(Net amount) request_type: type: string description: Let me know if the balance will be added or deducted example: money_out enum: - money_out - money_in transaction_type: type: string description: >- The type of transaction that causes a balance change. example: settlement enum: - payment - payout - settlement - refund - topup - withdrawal - dispute - dispute_fee - cashback_payout - transfer_in - transfer_out currency: type: string description: Currency unit. example: AUD payment_method: type: string example: bsb description: The payment method used. status: type: string description: Provide the current status of the balance flow. example: done enum: - waiting - done - failed reference_id: type: string example: BAL_cqxDHqDOSs8=--4 description: The identifier code used for referencing. balance_detail: type: object properties: outgoing: type: number example: 205 description: Amount of a transaction excluding fees. total: type: number example: 202.66 description: >- Amount of a transaction charged (Actual amount will fluctuate). fees: type: number example: 2.34 description: The fee of a transaction. created_at: type: string description: >- Timestamp when the balance transaction was created (UTC Time) example: 2026-01-01T00:00:00.000+0000 '400': description: Bad Request '401': description: Unauthorized content: application/json: schema: type: object properties: errors: type: object properties: code: type: string message: type: string example: errors: code: REQUIRE_LOGIN message: Not Authorised '422': description: Unprocessable Entity content: application/json: schema: type: object properties: errors: type: object properties: from_date: type: string example: errors: message: from date not valid 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 - [Get Balance History](/api/balance/get-balance-history.md) - [Balance API Reference (v2)](/api/v2/balance.md) - [AUD Balance API Reference](/api/v1/balance.md)