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

# Listar códigos BR estáticos

> Devuelve una lista paginada de códigos BR estáticos, con filtros opcionales por clave y estado.



## OpenAPI

````yaml es/openapi/v3-current/pix-lerian-cob.yaml GET /brcodes/static
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API pública para códigos BR Pix y cobros inmediatos y con fecha de
    vencimiento.
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
  title: Pix Lerian — Cobros
  version: release-candidate
servers:
  - url: https://api.example.com/cob-hub/v1
    description: >-
      El host de ejemplo debe reemplazarse por la URL proporcionada durante el
      onboarding del entorno.
security:
  - BearerAuth: []
tags:
  - description: >-
      Creación, consulta, listado y decodificación de códigos BR estáticos de
      Pix.
    name: BR Codes
  - description: Creación, consulta, listado y cancelación de cobros Pix inmediatos.
    name: Immediate Collections
  - description: Creación, consulta, listado y cancelación de cobros Pix con vencimiento.
    name: Due-Date Collections
paths:
  /brcodes/static:
    get:
      tags:
        - BR Codes
      summary: Listar códigos BR estáticos
      description: >-
        Devuelve una lista paginada de códigos BR estáticos, con filtros
        opcionales por clave y estado.
      operationId: listStaticBRCodes
      parameters:
        - description: Page number (1-based, default 1)
          explode: false
          in: query
          name: page
          schema:
            description: Page number (1-based, default 1)
            examples:
              - '1'
            type: string
          example: '1'
        - description: Rows per page (default 20, max 100)
          explode: false
          in: query
          name: limit
          schema:
            description: Rows per page (default 20, max 100)
            examples:
              - '20'
            type: string
          example: '20'
        - description: Filter by Pix key value (exact match)
          explode: false
          in: query
          name: key_value
          schema:
            description: Filter by Pix key value (exact match)
            type: string
          example: key-value-example
        - description: Filter by status (ACTIVE, CANCELLED)
          explode: false
          in: query
          name: status
          schema:
            description: Filter by status (ACTIVE, CANCELLED)
            examples:
              - ACTIVE
            type: string
          example: ACTIVE
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStaticBRCodesOutput'
              examples:
                ejemploFicticio:
                  summary: Ejemplo ficticio
                  value:
                    items:
                      - amount: '100.50'
                        createdAt: '2026-05-06T10:30:00Z'
                        currency: BRL
                        description: Pagamento do pedido 12345
                        emvPayload: >-
                          00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja
                          Teste6007Goiania62110507TX123456304AA54
                        id: 0196a7b2-1c3d-7e4f-8a90-1234567890ab
                        keyType: CPF
                        keyValue: '39053344705'
                        merchantCity: Goiania
                        merchantName: Loja Teste
                        organizationId: 0196a7b2-2d4e-7f50-9b01-234567890abc
                        status: ACTIVE
                        type: STATIC
                        updatedAt: '2026-05-06T10:30:00Z'
                    limit: 20
                    page: 1
                    total: 1
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      x-codeSamples:
        - lang: bash
          label: cURL con datos ficticios
          source: |-
            curl --request GET \
              --url https://api.example.com/cob-hub/v1/brcodes/static \
              --header 'Authorization: Bearer demo-access-token'
components:
  schemas:
    ListStaticBRCodesOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GetStaticBRCodeOutput'
          type:
            - array
            - 'null'
        limit:
          examples:
            - 20
          format: int64
          type: integer
        page:
          examples:
            - 1
          format: int64
          type: integer
        total:
          examples:
            - 1
          format: int64
          type: integer
      required:
        - items
        - total
        - page
        - limit
      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
    GetStaticBRCodeOutput:
      additionalProperties: false
      properties:
        amount:
          examples:
            - '100.50'
          type: string
        createdAt:
          examples:
            - '2026-05-06T10:30:00Z'
          format: date-time
          type: string
        currency:
          enum:
            - BRL
          examples:
            - BRL
          type: string
        description:
          examples:
            - Pagamento do pedido 12345
          type: string
        emvPayload:
          examples:
            - >-
              00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja
              Teste6007Goiania62110507TX123456304AA54
          type: string
        id:
          examples:
            - 0196a7b2-1c3d-7e4f-8a90-1234567890ab
          type: string
        keyType:
          enum:
            - CPF
            - CNPJ
            - PHONE
            - EMAIL
            - EVP
          examples:
            - CPF
          type: string
        keyValue:
          examples:
            - '39053344705'
          type: string
        merchantCity:
          examples:
            - Goiania
          type: string
        merchantName:
          examples:
            - Loja Teste
          type: string
        organizationId:
          examples:
            - 0196a7b2-2d4e-7f50-9b01-234567890abc
          type: string
        status:
          enum:
            - ACTIVE
            - CANCELLED
          examples:
            - ACTIVE
          type: string
        type:
          enum:
            - STATIC
          examples:
            - STATIC
          type: string
        updatedAt:
          examples:
            - '2026-05-06T10:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - type
        - keyType
        - keyValue
        - merchantName
        - merchantCity
        - emvPayload
        - status
        - createdAt
        - updatedAt
      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

````