> ## 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 todos los estados de VSync

> Usa este endpoint para listar todos los estados de VSync de los tipos de clave PIX con filtros opcionales.
Devuelve un arreglo vacío [] si ningún estado de VSync coincide con los criterios.
Nota: Esta tabla tiene como máximo 5 registros (uno por cada tipo de clave PIX: CPF, CNPJ, EMAIL, PHONE, EVP).



## OpenAPI

````yaml es/openapi/v3-current/indirect-pix.yaml GET /v1/dict/vsync
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - 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-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/vsync:
    get:
      tags:
        - Reconciliation API
      summary: Listar todos los estados de VSync
      description: >-
        Usa este endpoint para listar todos los estados de VSync de los tipos de
        clave PIX con filtros opcionales.

        Devuelve un arreglo vacío [] si ningún estado de VSync coincide con los
        criterios.

        Nota: Esta tabla tiene como máximo 5 registros (uno por cada tipo de
        clave PIX: CPF, CNPJ, EMAIL, PHONE, EVP).
      parameters:
        - name: page
          in: query
          description: 'Número de página para la paginación (predeterminado: 1, mínimo: 1)'
          schema:
            type: integer
        - name: limit
          in: query
          description: >-
            Cantidad máxima de elementos por página (predeterminado: 5, rango:
            1-100)
          schema:
            type: integer
        - name: key_type
          in: query
          description: 'Filtra por tipo de clave: CPF, CNPJ, EMAIL, PHONE, EVP'
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Filtra por estado de sincronización: SYNCED, OUT_OF_SYNC,
            RECONCILING, ERROR
          schema:
            type: string
        - name: sort_order
          in: query
          description: 'Dirección de orden: asc o desc (predeterminado: asc)'
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllVSyncStatesOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    GetAllVSyncStatesOutput:
      properties:
        items:
          description: Items es el arreglo de estados VSync de la página actual
          items:
            $ref: '#/components/schemas/VSyncStateOutput'
          type: array
        limit:
          description: Limit es la cantidad de elementos por página
          example: 10
          type: integer
        page:
          description: Page es el número de página actual
          example: 1
          type: integer
        total:
          description: >-
            Total es la cantidad total de estados VSync que coinciden con los
            filtros
          example: 5
          type: integer
      type: object
    BadRequestError:
      properties:
        code:
          example: PIX-1000
          type: string
        message:
          example: >-
            Invalid input: missing fields, invalid format, EVP key with value,
            invalid UUID, key limit exceeded, or invalid key type
          type: string
        title:
          example: Bad Request
          type: string
      type: object
    InternalError:
      properties:
        code:
          example: PIX-2010
          type: string
        message:
          example: Internal server error
          type: string
        title:
          example: Internal Server Error
          type: string
      type: object
    VSyncStateOutput:
      properties:
        createdAt:
          description: |-
            CreatedAt es el momento en que se creó este registro de estado VSync
            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
        id:
          description: |-
            ID es el identificador único de este estado VSync
            Formato: UUID v7
          example: 0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b
          type: string
        keyType:
          description: |-
            KeyType es el tipo de clave PIX para este estado VSync
            Valores válidos: CPF, CNPJ, EMAIL, PHONE, EVP
          example: CPF
          type: string
        lastCidCreatedAt:
          description: >-
            LastCIDCreatedAt es la marca de tiempo de creación del último CID
            procesado

            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
        lastFullReconciliation:
          description: >-
            LastFullReconciliation es el momento en que se realizó la última
            conciliación completa

            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
        lastSyncCheck:
          description: >-
            LastSyncCheck es el momento en que se realizó la última verificación
            de sincronización con BTG

            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
        lastSyncStatus:
          description: |-
            LastSyncStatus es el estado de sincronización actual
            Valores válidos: SYNCED, OUT_OF_SYNC, RECONCILING, ERROR
          example: SYNCED
          type: string
        lastSyncTimestamp:
          description: >-
            LastSyncTimestamp es el momento en que se calculó por última vez el
            VSync local

            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
        localVSync:
          description: LocalVSync es el valor del VSync local (64 caracteres hexadecimales)
          example: '0000000000000000000000000000000000000000000000000000000000000000'
          type: string
        updatedAt:
          description: >-
            UpdatedAt es el momento en que se actualizó por última vez este
            registro de estado VSync

            Formato: marca de tiempo ISO 8601 UTC con sufijo Z
          example: '2024-01-15T10:30:00Z'
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````