> ## 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 os Estados de VSync

> Use este endpoint para listar todos os estados de VSync para os tipos de chave PIX com filtros opcionais.
Retorna um array vazio [] se nenhum estado de VSync corresponder aos critérios.
Nota: Esta tabela tem no máximo 5 registros (um por tipo de chave PIX: CPF, CNPJ, EMAIL, PHONE, EVP).



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml GET /v1/dict/vsync
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  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 os Estados de VSync
      description: >-
        Use este endpoint para listar todos os estados de VSync para os tipos de
        chave PIX com filtros opcionais.

        Retorna um array vazio [] se nenhum estado de VSync corresponder aos
        critérios.

        Nota: Esta tabela tem no máximo 5 registros (um por tipo de chave PIX:
        CPF, CNPJ, EMAIL, PHONE, EVP).
      parameters:
        - name: page
          in: query
          description: 'Número da página para paginação (padrão: 1, mínimo: 1)'
          schema:
            type: integer
        - name: limit
          in: query
          description: 'Número máximo de itens por página (padrão: 5, intervalo: 1-100)'
          schema:
            type: integer
        - name: key_type
          in: query
          description: 'Filtra pelo tipo de chave: CPF, CNPJ, EMAIL, PHONE, EVP'
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Filtra pelo status de sincronização: SYNCED, OUT_OF_SYNC,
            RECONCILING, ERROR
          schema:
            type: string
        - name: sort_order
          in: query
          description: 'Direção da ordenação: asc ou desc (padrão: 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 é o array de estados VSync da página atual
          items:
            $ref: '#/components/schemas/VSyncStateOutput'
          type: array
        limit:
          description: Limit é o número de itens por página
          example: 10
          type: integer
        page:
          description: Page é o número da página atual
          example: 1
          type: integer
        total:
          description: Total é o número total de estados VSync que correspondem aos filtros
          example: 5
          type: integer
      type: object
    BadRequestError:
      properties:
        code:
          example: PIX-1000
          type: string
        message:
          example: >-
            Entrada inválida: campos ausentes, formato inválido, chave EVP com
            valor, UUID inválido, limite de chaves excedido ou tipo de chave
            inválido
          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 é quando este registro de estado VSync foi criado
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        id:
          description: |-
            ID é o identificador único deste estado VSync
            Format: UUID v7
          example: 0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b
          type: string
        keyType:
          description: |-
            KeyType é o tipo de chave PIX para este estado VSync
            Valores válidos: CPF, CNPJ, EMAIL, PHONE, EVP
          example: CPF
          type: string
        lastCidCreatedAt:
          description: |-
            LastCIDCreatedAt é o timestamp de criação do último CID processado
            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        lastFullReconciliation:
          description: >-
            LastFullReconciliation é quando a última reconciliação completa foi
            realizada

            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        lastSyncCheck:
          description: >-
            LastSyncCheck é quando a última verificação de sincronização foi
            realizada com o BTG

            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        lastSyncStatus:
          description: |-
            LastSyncStatus é o status de sincronização atual
            Valores válidos: SYNCED, OUT_OF_SYNC, RECONCILING, ERROR
          example: SYNCED
          type: string
        lastSyncTimestamp:
          description: >-
            LastSyncTimestamp é quando o VSync local foi calculado pela última
            vez

            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
        localVSync:
          description: LocalVSync é o valor do VSync local (64 caracteres hexadecimais)
          example: '0000000000000000000000000000000000000000000000000000000000000000'
          type: string
        updatedAt:
          description: >-
            UpdatedAt é quando este registro de estado VSync foi atualizado pela
            última vez

            Format: ISO 8601 UTC timestamp with Z suffix
          example: '2024-01-15T10:30:00Z'
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````