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

# Consultar breakdown do saldo

> Composição detalhada do saldo: disponível, pendente de liberação e reservas (refunds/disputas em andamento).



## OpenAPI

````yaml /openapi/korbit-public-v1.json get /v1/balance/breakdown
openapi: 3.1.0
info:
  title: Korbit API
  version: 1.0.0
  description: >-
    API de pagamentos da Korbit para merchants: PIX, cartão (com 3DS),
    assinaturas, checkout por link, payouts, antecipações e refunds — com
    idempotência, webhooks assinados e ambiente sandbox.
  contact:
    name: Suporte Korbit
    email: suporte@korbit.com.br
servers:
  - url: https://api.korbit.com.br
    description: Produção (chaves kbt_live_)
  - url: https://api-test.korbit.com.br
    description: Sandbox (chaves kbt_test_)
security:
  - bearerAuth: []
tags:
  - name: Antecipações
  - name: Assinaturas
  - name: Atividade
  - name: Catálogo
  - name: Chaves de API
  - name: Checkout
  - name: Clientes e Pedidos
  - name: Pagamentos
  - name: Refunds e Disputas
  - name: Saldo e Saques
  - name: Sandbox
  - name: Webhooks
paths:
  /v1/balance/breakdown:
    get:
      tags:
        - Saldo e Saques
      summary: Consultar breakdown do saldo
      description: >-
        Composição detalhada do saldo: disponível, pendente de liberação e
        reservas (refunds/disputas em andamento).
      operationId: getMerchantBalanceBreakdown
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - asOfTime
                  - availableAmount
                  - negativeReceivableAmount
                  - nextReleaseAt
                  - pendingAmount
                  - reserveAmount
                  - chargebackHeldAmount
                  - medHeldAmount
                  - refundInTransitAmount
                  - scheduledPrincipalRemainingAmount
                  - scheduledReserveRemainingAmount
                  - reconciliationRequired
                properties:
                  asOfTime:
                    type: string
                    format: date-time
                  availableAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  negativeReceivableAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  nextReleaseAt:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                  pendingAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  reserveAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  chargebackHeldAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  medHeldAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  refundInTransitAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  scheduledPrincipalRemainingAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  scheduledReserveRemainingAmount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  reconciliationRequired:
                    type: boolean
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
      security:
        - bearerAuth: []
        - dashboardSessionCookie: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Korbit API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.