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

# List PIX transaction limits

> Lists the PIX limit rows that exist for the account named by account_id. Each row is a (transactionType, periodType, limitType) tuple plus an amount in centavos: periodType is DAILY, NIGHTLY or MONTHLY; limitType is TRANSACTION, the cap on a single payment, or PERIOD, the cap on everything inside the window; transactionType is always PIX.

No endpoint in this API creates a limit row. Four of them - PERIOD and TRANSACTION for DAILY and NIGHTLY, at a deployment-configured default of 30000 reais - are seeded lazily the first time POST /v1/transactions runs the limit check for the account, and a MONTHLY row is never created by the service at all. Until that first payment attempt this route answers 200 with an empty data array rather than a 404, and PATCH /v1/limits has no row to change. An account_id the CRM cannot resolve is 404 PIX-2016.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/limits
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/limits:
    get:
      tags:
        - Limits
      summary: List PIX transaction limits
      description: >-
        Lists the PIX limit rows that exist for the account named by account_id.
        Each row is a (transactionType, periodType, limitType) tuple plus an
        amount in centavos: periodType is DAILY, NIGHTLY or MONTHLY; limitType
        is TRANSACTION, the cap on a single payment, or PERIOD, the cap on
        everything inside the window; transactionType is always PIX.


        No endpoint in this API creates a limit row. Four of them - PERIOD and
        TRANSACTION for DAILY and NIGHTLY, at a deployment-configured default of
        30000 reais - are seeded lazily the first time POST /v1/transactions
        runs the limit check for the account, and a MONTHLY row is never created
        by the service at all. Until that first payment attempt this route
        answers 200 with an empty data array rather than a 404, and PATCH
        /v1/limits has no row to change. An account_id the CRM cannot resolve is
        404 PIX-2016.
      operationId: getTransactionLimits
      parameters:
        - description: The CRM account id whose limits to read.
          explode: false
          in: query
          name: account_id
          required: true
          schema:
            description: The CRM account id whose limits to read.
            examples:
              - acc-123
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionLimitsBody'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    TransactionLimitsBody:
      additionalProperties: false
      properties:
        data:
          description: The list of transaction limits.
          items:
            $ref: '#/components/schemas/TransactionLimitItem'
          type:
            - array
            - 'null'
      required:
        - data
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    TransactionLimitItem:
      additionalProperties: false
      properties:
        accountId:
          description: The account id (externalId).
          examples:
            - ext-acc-123
          type: string
        amount:
          description: The limit amount in centavos.
          examples:
            - 3000000
          format: int64
          type: integer
        id:
          description: The limit row id.
          examples:
            - l1f9c0a2-...
          type: string
        limitType:
          description: eTransactionLimitType name.
          examples:
            - PERIOD
          type: string
        periodType:
          description: ePeriodType name.
          examples:
            - DAILY
          type: string
        transactionType:
          description: eTransactionType name.
          examples:
            - PIX
          type: string
      required:
        - id
        - accountId
        - transactionType
        - periodType
        - limitType
        - amount
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````