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

# Get customer credit balance

> Returns the credit balance for a customer identified by reference.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/sdk/customers/{reference}/balance
openapi: 3.0.0
info:
  contact: {}
  description: The SolvaPay REST API specification
  title: SolvaPay REST API
  version: '1.0'
servers: []
security: []
tags: []
paths:
  /v1/sdk/customers/{reference}/balance:
    get:
      tags:
        - Customers
      summary: Get customer credit balance
      description: Returns the credit balance for a customer identified by reference.
      operationId: CustomerSdkController_getCustomerBalance
      parameters:
        - description: Customer reference identifier
          in: path
          name: reference
          required: true
          schema:
            example: cus_3c4d5e6f7g8h
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerBalanceResponse'
          description: Customer balance retrieved successfully
        '404':
          content:
            application/json:
              schema:
                example:
                  error: Not Found
                  message: Customer with reference cus_3c4d5e6f7g8h not found
                  statusCode: 404
          description: Customer not found
      security:
        - SecretKey: []
components:
  schemas:
    CustomerBalanceResponse:
      properties:
        credits:
          description: Raw credit balance in credits (100 credits = 1 minor currency unit)
          example: 4200
          type: number
        creditsPerMinorUnit:
          description: Number of credits per minor currency unit
          example: 100
          type: number
        customerRef:
          description: Customer reference identifier
          example: cus_3c4d5e6f7g8h
          type: string
        display:
          allOf:
            - $ref: '#/components/schemas/CustomerBalanceDisplayDto'
          description: Formatted balance display block for the display currency
        displayCurrency:
          description: ISO 4217 display currency code
          example: USD
          type: string
        displayExchangeRate:
          description: Exchange rate from USD to the display currency
          example: 1
          type: number
      required:
        - customerRef
        - credits
        - displayCurrency
        - creditsPerMinorUnit
        - displayExchangeRate
        - display
      type: object
    CustomerBalanceDisplayDto:
      properties:
        amountMajor:
          description: Balance amount in the display currency major units (e.g. dollars)
          example: 42
          type: number
        currency:
          description: ISO 4217 display currency code
          example: USD
          type: string
        exchangeRate:
          description: Exchange rate applied from USD to the display currency
          example: 1
          type: number
        formatted:
          description: Human-readable formatted balance
          example: $42.00
          type: string
        rateSource:
          description: Source of the exchange rate used
          enum:
            - parity
            - db
            - fallback
          example: parity
          type: string
      required:
        - amountMajor
        - currency
        - formatted
        - exchangeRate
        - rateSource
      type: object
  securitySchemes:
    SecretKey:
      bearerFormat: JWT
      description: >-
        Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer
        token.
      scheme: bearer
      type: http

````