> ## 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.

# Retrieve available limits

> Check available transaction limits with current usage.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml GET /v1/limits/available
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  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: Retrieve available limits
      description: Check available transaction limits with current usage.
      parameters:
        - $ref: '#/components/parameters/AccountIdQuery'
      responses:
        '200':
          description: Available limits retrieved successfully
          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: Account identifier.
      schema:
        type: string
        format: uuid
      example: 019c96a0-0a98-7287-9a31-786e0809c769
  schemas:
    AvailableLimitsResponse:
      type: object
      required:
        - limits
        - currentPeriod
      properties:
        limits:
          type: array
          description: List of available limits for the account.
          items:
            type: object
            required:
              - limitType
              - periodType
              - totalLimit
              - usedAmount
              - availableAmount
            properties:
              limitType:
                $ref: '#/components/schemas/LimitTypeEnum'
              periodType:
                $ref: '#/components/schemas/PeriodTypeEnum'
              totalLimit:
                type: number
                description: Total limit amount.
                format: double
                example: 5000
              usedAmount:
                type: number
                description: Amount already used in the current period.
                format: double
                example: 1250.5
              availableAmount:
                type: number
                description: Amount still available for use in the current period.
                format: double
                example: 3749.5
        currentPeriod:
          type: string
          description: Current period for the limits (e.g., "2023-06" for monthly limits).
          format: date
          example: '2023-06-15'
    LimitTypeEnum:
      type: string
      description: >
        Transaction limit direction type. String values specifying whether the
        limit applies to incoming or outgoing transactions.


        **Valid values:**

        - `DEBIT` = Outgoing transaction limit (money leaving the account)

        - `CREDIT` = Incoming transaction limit (money entering the account)
      enum:
        - DEBIT
        - CREDIT
      example: DEBIT
    PeriodTypeEnum:
      type: string
      description: >
        Transaction limit period type. String values defining the time period
        for which transaction limits apply.


        **Valid values:**

        - `DAILY` = Daily limit (resets every day at midnight)

        - `NIGHTLY` = Nightly period limit (typically 8 PM to 6 AM per Brazilian
        banking regulations)

        - `MONTHLY` = Monthly limit (resets on the first day of each month)

        - `YEARLY` = Yearly limit (resets on January 1st each year)
      enum:
        - DAILY
        - NIGHTLY
        - MONTHLY
        - YEARLY
      example: DAILY
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
        details:
          type: array
          items:
            type: string
          description: Additional error details
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      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: Not Found - Resource does not exist
      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: Internal Server Error
      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: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````