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

# Balance

> Retrieves the balance of the authenticated business account used for outgoing payments and incoming collections.



## OpenAPI

````yaml /openapi-v3.en.yaml get /v3/transactions/payouts/balance
openapi: 3.0.0
info:
  title: YP API Partner
  description: Integration documentation for YP API partners.
  version: v3
  contact: {}
servers:
  - url: https://sandbox-rampa.mesadepagos.com/api
    description: Sandbox
security: []
tags:
  - name: Auth
    description: ''
  - name: Quotes
    description: ''
  - name: Payin
    description: ''
  - name: Payout
    description: ''
  - name: Wallet
    description: ''
  - name: Queries
    description: ''
  - name: Webhooks
    description: ''
  - name: Fees
    description: ''
  - name: Clients
    description: ''
  - name: Client verifications
    description: Las verificaciones que habilitan a un cliente a cobrar a su nombre.
  - name: Virtual accounts
    description: 'Las cuentas de cobro: las del partner y las de sus clientes.'
paths:
  /v3/transactions/payouts/balance:
    get:
      tags:
        - Queries
      summary: Balance
      description: >-
        Retrieves the balance of the authenticated business account used for
        outgoing payments and incoming collections.
      operationId: getBalanceV3
      parameters: []
      responses:
        '200':
          description: Account balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceV3ResponseDoc'
        '400':
          description: Business has no configured account or the request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceV3ValidationErrorResponseDoc'
        '401':
          description: Missing, invalid, or expired token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceV3UnauthorizedResponseDoc'
        '503':
          description: The balance could not be retrieved at this time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceV3ServiceUnavailableResponseDoc'
      security:
        - bearer: []
components:
  schemas:
    BalanceV3ResponseDoc:
      type: object
      properties:
        fiat:
          type: string
          enum:
            - BOB
          example: BOB
          description: Balance fiat currency.
        available:
          type: number
          example: 1000
          description: Available balance for transactions.
        accounting:
          type: number
          example: 1200
          description: >-
            Accounting balance, including amounts that have not yet been
            released.
        held:
          type: number
          example: 200
          description: Held balance, unavailable for transactions.
        lastCredit:
          type: string
          example: '2026-05-12T12:00:00.000Z'
          nullable: true
          description: Date of the last credit. Null if the account has no credits.
        lastDebit:
          type: string
          example: '2026-05-12T12:00:00.000Z'
          nullable: true
          description: Date of the last debit. Null if the account has no debits.
      required:
        - fiat
        - available
        - accounting
        - held
        - lastCredit
        - lastDebit
    BalanceV3ValidationErrorResponseDoc:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        message:
          type: string
          example: Business has no comercio account configured
        error:
          type: string
          example: Bad Request
      required:
        - statusCode
        - message
        - error
    BalanceV3UnauthorizedResponseDoc:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        message:
          type: string
          example: Unauthorized
      required:
        - statusCode
        - message
    BalanceV3ServiceUnavailableResponseDoc:
      type: object
      properties:
        statusCode:
          type: number
          example: 503
        message:
          type: string
          example: Failed to fetch merchant balance
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT obtained from /v2/auth/login or /v3/auth/login

````

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