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

# List account balances

> List live account balances for a merchant, one entry per account and currency. The account with the refund role holds the funds available for refunds. Omit merchant_id when calling with merchant credentials (resolved from the token); partner and admin callers must supply it.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/balances
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: API documentation for Quidkey Core Services
servers:
  - url: https://core.quidkey.com
    description: Production
security: []
paths:
  /api/v1/balances:
    get:
      tags:
        - Balances
      summary: List account balances
      description: >-
        List live account balances for a merchant, one entry per account and
        currency. The account with the refund role holds the funds available for
        refunds. Omit merchant_id when calling with merchant credentials
        (resolved from the token); partner and admin callers must supply it.
      operationId: balances.list
      parameters:
        - name: merchant_id
          in: query
          required: false
          description: >-
            Merchant to read balances for. Omit when calling with merchant
            credentials; required for partner and admin callers.
          schema:
            format: uuid
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balance_ListResponse'
              example:
                success: true
                data:
                  - id: 550e8400-e29b-41d4-a716-446655440000
                    currency: GBP
                    roles:
                      - refund
                    balance: '1234.56'
                  - id: 550e8400-e29b-41d4-a716-446655440001
                    currency: EUR
                    roles:
                      - refund
                    balance: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error400'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error404'
      security:
        - bearerAuth: []
components:
  schemas:
    balance_ListResponse:
      title: Balance List Response
      description: Live balances for a merchant's accounts, one entry per account
      type: object
      required:
        - success
        - data
      properties:
        success:
          description: Indicates if the request was successful
          examples:
            - true
          type: boolean
        data:
          type: array
          items:
            title: Balance
            description: Live balance for a single merchant account
            type: object
            required:
              - id
              - currency
              - roles
              - balance
            properties:
              id:
                type: string
                format: uuid
                description: Unique identifier of the account this balance belongs to
                examples:
                  - 550e8400-e29b-41d4-a716-446655440000
              currency:
                type: string
                pattern: ^[A-Za-z]{3}$
                minLength: 3
                maxLength: 3
                description: Currency of the account
                examples:
                  - GBP
                  - USD
                  - EUR
              roles:
                type: array
                description: >-
                  Roles this account serves. The account with the refund role
                  holds the funds refunds are paid from.
                items:
                  description: The purpose an account serves
                  anyOf:
                    - const: receiving
                      type: string
                    - const: settlement
                      type: string
                    - const: refund
                      type: string
              balance:
                description: >-
                  Live balance in the account currency, or null when temporarily
                  unavailable.
                anyOf:
                  - type: string
                    examples:
                      - '1234.56'
                  - type: 'null'
    shared_Error400:
      title: Bad Request Error
      description: 400 Bad Request Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - description: Error code for the specific error type
                  examples:
                    - VALIDATION_ERROR
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
            metadata:
              additionalProperties: true
              description: >-
                Additional error context. For VALIDATION_ERROR, includes a
                per-field `errors` array.
              type: object
              properties:
                errors:
                  type: array
                  items:
                    type: object
                    required:
                      - field
                      - message
                    properties:
                      field:
                        type: string
                      message:
                        type: string
    shared_Error401:
      title: Unauthorized Error
      description: 401 Unauthorized Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - const: UNAUTHORIZED
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
    shared_Error403:
      title: Forbidden Error
      description: 403 Forbidden Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - description: Error code for forbidden access
                  examples:
                    - FORBIDDEN_CREATE
                    - FORBIDDEN_VIEW
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
    shared_Error404:
      title: Not Found Error
      description: 404 Not Found Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - description: Error code for resource not found
                  examples:
                    - MERCHANT_NOT_FOUND
                    - BANK_NOT_FOUND
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````