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

# Retrieve ledger-derived balances for the merchant dashboard

> First-party dashboard endpoint authenticated with the signed-in merchant user's Clerk session. It is not intended for unattended merchant server integrations.




## OpenAPI

````yaml /openapi.yaml get /v1/dashboard/balance
openapi: 3.1.0
info:
  title: Skinloop API
  version: 1.1.0-draft
  description: |
    Public contract for Skinloop merchant payments, hosted checkout status,
    merchant dashboard reads, and merchant webhooks. Skinloop never exposes
    credentials, private identifiers, trade URLs, or client tokens.
servers:
  - url: https://api.skinloop.io
    description: Production
security: []
tags:
  - name: Payments
  - name: Checkout
  - name: Reporting
  - name: Dashboard
paths:
  /v1/dashboard/balance:
    get:
      tags:
        - Dashboard
      summary: Retrieve ledger-derived balances for the merchant dashboard
      description: >
        First-party dashboard endpoint authenticated with the signed-in merchant
        user's Clerk session. It is not intended for unattended merchant server
        integrations.
      operationId: getDashboardBalance
      responses:
        '200':
          description: Current balances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantBalance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - clerkBearer: []
components:
  schemas:
    MerchantBalance:
      type: object
      additionalProperties: false
      required:
        - currency
        - availableMinor
        - pendingMinor
        - heldMinor
        - payoutReadyMinor
        - pendingPayoutMinor
      properties:
        currency:
          type: string
          const: USD
        availableMinor:
          type: string
          pattern: ^[0-9]+$
          description: Posted balance currently available, in integer USD cents.
        pendingMinor:
          type: string
          pattern: ^[0-9]+$
          description: >-
            Payments in initiated, pending, or active state, in integer USD
            cents.
        heldMinor:
          type: string
          pattern: ^[0-9]+$
          description: Payments in provider hold state, in integer USD cents.
        payoutReadyMinor:
          type: string
          pattern: ^[0-9]+$
          description: >-
            Posted balance eligible to enter the payout flow, in integer USD
            cents.
        pendingPayoutMinor:
          type: string
          pattern: ^-?[0-9]+$
          description: >-
            Amount currently reserved in the payout-clearing account, in integer
            USD cents.
      example:
        currency: USD
        availableMinor: '4999'
        pendingMinor: '2500'
        heldMinor: '1000'
        payoutReadyMinor: '4999'
        pendingPayoutMinor: '0'
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
  responses:
    Unauthorized:
      description: Authentication or signature verification failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Checkout origin is not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: Checkout service is not configured or unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    clerkBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk session token for the merchant dashboard.

````