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

# Recuperar límites disponibles

> Consulta los límites de transacción disponibles junto con el uso actual.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/limits/available
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/limits/available:
    get:
      tags:
        - Transaction Limits API
      summary: Recuperar límites disponibles
      description: Consulta los límites de transacción disponibles junto con el uso actual.
      parameters:
        - $ref: '#/components/parameters/AccountIdQuery'
      responses:
        '200':
          description: Límites disponibles recuperados correctamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableLimitsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    AccountIdQuery:
      name: account_id
      in: query
      required: false
      description: Identificador de la cuenta.
      schema:
        type: string
        format: uuid
      example: 019c96a0-0a98-7287-9a31-786e0809c769
  schemas:
    AvailableLimitsResponse:
      type: object
      required:
        - limits
        - currentPeriod
      properties:
        limits:
          type: array
          description: Lista de límites disponibles para la cuenta.
          items:
            type: object
            required:
              - limitType
              - periodType
              - totalLimit
              - usedAmount
              - availableAmount
            properties:
              limitType:
                $ref: '#/components/schemas/LimitTypeEnum'
              periodType:
                $ref: '#/components/schemas/PeriodTypeEnum'
              totalLimit:
                type: number
                description: Monto total del límite.
                format: double
                example: 5000
              usedAmount:
                type: number
                description: Monto ya utilizado en el periodo actual.
                format: double
                example: 1250.5
              availableAmount:
                type: number
                description: Monto aún disponible para usar en el periodo actual.
                format: double
                example: 3749.5
        currentPeriod:
          type: string
          description: >-
            Periodo actual de los límites (p. ej., "2023-06" para límites
            mensuales).
          format: date
          example: '2023-06-15'
    LimitTypeEnum:
      type: string
      description: >
        Tipo de dirección del límite de transacción. Valores en texto que
        especifican si el límite aplica a transacciones entrantes o salientes.


        **Valores válidos:**

        - `DEBIT` = Límite de transacciones salientes (dinero que sale de la
        cuenta)

        - `CREDIT` = Límite de transacciones entrantes (dinero que entra a la
        cuenta)
      enum:
        - DEBIT
        - CREDIT
      example: DEBIT
    PeriodTypeEnum:
      type: string
      description: >
        Tipo de periodo del límite de transacción. Valores en texto que definen
        el periodo de tiempo al que aplican los límites.


        **Valores válidos:**

        - `DAILY` = Límite diario (se restablece cada día a medianoche)

        - `NIGHTLY` = Límite nocturno (generalmente de 20:00 a 6:00, según la
        regulación bancaria brasileña)

        - `MONTHLY` = Límite mensual (se restablece el primer día de cada mes)

        - `YEARLY` = Límite anual (se restablece el 1 de enero de cada año)
      enum:
        - DAILY
        - NIGHTLY
        - MONTHLY
        - YEARLY
      example: DAILY
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Código de error
        message:
          type: string
          description: Mensaje de error
        details:
          type: array
          items:
            type: string
          description: Detalles adicionales del error
  responses:
    Unauthorized:
      description: No Autorizado - Autenticación inválida o ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing authentication token
              value:
                code: MISSING_TOKEN
                message: Authorization header is required
                details: []
            invalid_token:
              summary: Invalid token
              value:
                code: INVALID_TOKEN
                message: Invalid or expired access token
                details: []
            expired_token:
              summary: Expired token
              value:
                code: TOKEN_EXPIRED
                message: Access token has expired. Please obtain a new token.
                details: []
    NotFound:
      description: No Encontrado - El recurso no existe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            pix_key_not_found:
              summary: Pix key not found
              value:
                code: PIX_KEY_NOT_FOUND
                message: PIX key does not exist or is not registered
                details: []
            account_not_found:
              summary: Account not found
              value:
                code: ACCOUNT_NOT_FOUND
                message: Account with specified ID does not exist
                details: []
            transaction_not_found:
              summary: Transaction not found
              value:
                code: TRANSACTION_NOT_FOUND
                message: Transaction not found
                details: []
    InternalServerError:
      description: Error Interno del Servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            generic_error:
              summary: Generic internal error
              value:
                code: INTERNAL_ERROR
                message: An internal error occurred. Please try again later.
                details: []
            database_error:
              summary: Database error
              value:
                code: DATABASE_ERROR
                message: Database operation failed
                details: []
            external_service_error:
              summary: External service error
              value:
                code: EXTERNAL_SERVICE_ERROR
                message: External service (JD PIX) is temporarily unavailable
                details: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````