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

# Get All Balances

> The Balance API allows merchants to retrieve real-time information about their account balance, including available funds, pending funds, reserved amounts, and transaction counts.
This endpoint is commonly used to determine payout eligibility, monitor settlement status, or display wallet/balance information in merchant dashboards.



## OpenAPI

````yaml api-reference/openapi.json get /v1/balances
openapi: 3.0.1
info:
  title: Monxa API
  description: ''
  version: 1.0.0
servers: []
security:
  - Bearer: []
tags:
  - name: balances
  - name: customers
  - name: merchants
  - name: charges
  - name: payouts
paths:
  /v1/balances:
    get:
      tags:
        - balances
      summary: Get All Balances
      description: >-
        The Balance API allows merchants to retrieve real-time information about
        their account balance, including available funds, pending funds,
        reserved amounts, and transaction counts.

        This endpoint is commonly used to determine payout eligibility, monitor
        settlement status, or display wallet/balance information in merchant
        dashboards.
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    merchant_id:
                      type: string
                      description: Unique identifier of the merchant account.
                    reserved_amount:
                      type: integer
                      description: >-
                        Funds reserved and not available for payout (e.g.,
                        unsettled, held for compliance checks).
                    total_amount:
                      type: integer
                      description: >-
                        Total funds recorded under the merchant account
                        (available + pending).
                    available_amount:
                      type: integer
                      description: Funds available for payout/withdrawal.
                    fee_amount:
                      type: integer
                      description: Accumulated transaction fees deducted from the account.
                    pending_amount:
                      type: integer
                      description: >-
                        Funds pending settlement (e.g., in-progress or clearing
                        transactions).
                    available_count:
                      type: integer
                      description: >-
                        Number of transactions that are already settled and
                        available.
                    pending_count:
                      type: integer
                      description: Number of transactions still pending settlement.
                    currency:
                      type: string
                      description: Currency code (ISO-4217), e.g., IDR, SGD.
                    last_modified_by:
                      type: string
                      description: User or system identifier of the last update action.
                    last_modified_on:
                      type: string
                      description: Timestamp when the record was last updated.
                    created_by:
                      type: string
                      description: User or system identifier that created the record.
                    created_on:
                      type: string
                      description: Timestamp when the record was created.
                    id:
                      type: string
                      description: Unique identifier for this balance record.
              example:
                - merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                  reserved_amount: 0
                  total_amount: 16995
                  available_amount: 0
                  fee_amount: 0
                  pending_amount: 16995
                  available_count: 0
                  pending_count: 7
                  currency: IDR
                  last_modified_by: System
                  last_modified_on: '2025-10-21T00:22:40.8945126+00:00'
                  created_by: System
                  created_on: '2025-10-21T00:22:40.8945126+00:00'
                  id: 63c3e1cc-8a94-4613-9b4d-9c72e46ef254
          headers: {}
      deprecated: false
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````