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

# Obter as janelas de horário de operação

> Retorna as grades de janela de operação anunciadas pelas transmissões de mudança de horário GEN0021 ("GEN avisa alteração de horários"). Cada janela carrega o código de grade oficial, as datas-hora de abertura/fechamento, o tipo de horário e o provedor que anuncia, de forma literal tal como anunciado. Uma grade reanunciada para a mesma data de referência sobrescreve a janela anterior. Opcionalmente filtre por data de referência com dtRef.



## OpenAPI

````yaml pt/openapi/v3-current/spb.yaml get /v1/str/schedule
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interface OpenAPI 3.1 do Lerian SPB, a integração direta entre a instituição
    e o Sistema de Pagamentos Brasileiro (SPB) sobre a Rede do Sistema
    Financeiro Nacional (RSFN). Abrange o Sistema de Transferência de Reservas
    (STR): registro de mensagens e catálogo de capacidades, ciclo de vida das
    operações (transferências bancárias, repasses IBS, transferências de
    liquidez, devoluções e cancelamentos), consultas de conta de reservas e de
    horários, governança de alçada, conciliação e entrega de eventos.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://spb.sandbox.lerian.net
security: []
tags:
  - description: >-
      Trilhas imutáveis de registros de auditoria para operações STR e eventos
      de ciclo de vida.
    name: Audit
  - description: >-
      Catálogo de capacidades STR que descreve os tipos de mensagem suportados e
      suas restrições.
    name: Capabilities
  - description: >-
      Inventário de certificados ICP-Brasil com rotação e ativação recarregáveis
      a quente.
    name: Certificates
  - description: >-
      Fila de aprovação maker-checker para emissões retidas acima de sua banda
      de alçada: listar pendentes, assinar (aprovar) e negar.
    name: EmissionApprovals
  - description: >-
      Registros de entrega de eventos por webhook com controle de retentativas
      para despachos falhos.
    name: EventDeliveries
  - description: >-
      Catálogo de eventos de operação que enumera os tipos de evento de domínio
      emitidos.
    name: Events
  - description: >-
      Registro de avisos recebidos da família GEN (GEN0001 eco de conectividade,
      GEN0004 erro de transmissão, GEN0005 aviso administrativo).
    name: GenNotices
  - description: >-
      Governança de alçada do SPB: a tabela de bandas de valor e os requisitos
      de assinatura por tipo de mensagem, recarregados a quente em tempo de
      execução.
    name: Governance
  - description: >-
      Estado bruto das mensagens STR: listar as mensagens e ler uma mensagem
      individual por NUOp.
    name: Messages
  - description: Resumos e métricas operacionais agregados das operações STR.
    name: OperationalIntelligence
  - description: >-
      Ciclo de vida das operações STR para transferências bancárias e repasses
      IBS, incluindo devoluções e cancelamentos.
    name: Operations
  - description: >-
      Estado de prontidão do serviço que abrange as autoverificações de
      inicialização e a saúde das dependências.
    name: Readiness
  - description: Casos de conciliação e as ações que resolvem as divergências de operação.
    name: Reconciliation
  - description: >-
      Suíte de relatórios STR: relatórios agregados síncronos por intervalo de
      datas (movimento financeiro, transações rejeitadas, volumetria) sobre o
      próprio registro de transmissão do Lerian SPB.
    name: Reports
  - description: >-
      Consultas de saldo de conta de reservas STR0013 e de extrato STR0014 (modo
      mensagem) e seus resultados assíncronos.
    name: ReserveQueries
  - description: >-
      Lista de responsáveis do participante GEN0019: atualizações de
      substituição total anunciadas ao BACEN.
    name: Responsibles
  - description: >-
      Programação de janelas de operação do STR que rege quando as operações
      podem ser enviadas.
    name: Schedule
  - description: >-
      Consultas de horários STR0001 de parte única (consulta de horários do STR)
      e seus resultados de grade STR0001R1 assíncronos.
    name: ScheduleQueries
  - description: Configurações de tempo de execução do SPB para a integração STR.
    name: Settings
  - description: >-
      Registro e gerenciamento de endpoints de webhook para a entrega de
      eventos.
    name: Webhooks
  - description: >-
      Fluxo (ordem obrigatória): certificado → prontidão →
      teste-de-conectividade → envio. Ative um certificado, confirme que o rail
      reporta prontidão, passe em um teste de conectividade e então envie uma
      operação. Cada etapa é seu próprio recurso; um envio não deve ser tentado
      antes de a prontidão passar.
    name: onboarding
  - description: >-
      Fluxo (ordem obrigatória): operação pai SETTLED → devolução/cancelamento.
      Uma devolução ou cancelamento é um sub-recurso de uma operação pai
      liquidada; o segmento de rota {operationId}/{endToEndID} impõe o pai
      estruturalmente.
    name: lifecycle
paths:
  /v1/str/schedule:
    get:
      tags:
        - Schedule
      summary: Obter as janelas de horário de operação
      description: >-
        Retorna as grades de janela de operação anunciadas pelas transmissões de
        mudança de horário GEN0021 ("GEN avisa alteração de horários"). Cada
        janela carrega o código de grade oficial, as datas-hora de
        abertura/fechamento, o tipo de horário e o provedor que anuncia, de
        forma literal tal como anunciado. Uma grade reanunciada para a mesma
        data de referência sobrescreve a janela anterior. Opcionalmente filtre
        por data de referência com dtRef.
      operationId: getSchedule
      parameters:
        - description: Reference date filter, verbatim as announced (e.g. 2026-06-10).
          explode: false
          in: query
          name: dtRef
          schema:
            description: Reference date filter, verbatim as announced (e.g. 2026-06-10).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ScheduleResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          examples:
            - req-7a3f9c2e
          type: string
        windows:
          description: Operating-window grades matching the request, ordered as persisted.
          items:
            $ref: '#/components/schemas/ScheduleWindowResponse'
          type:
            - array
            - 'null'
      required:
        - windows
        - correlationId
      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
      type: object
    ScheduleWindowResponse:
      additionalProperties: false
      properties:
        announcedAt:
          description: Optional datetime the grade was announced, verbatim as announced.
          examples:
            - '2026-06-10T05:00:00'
          type: string
        closesAt:
          description: >-
            Window closing datetime, verbatim as announced (BACEN local, no
            timezone offset).
          examples:
            - '2026-06-10T18:30:00'
          type: string
        dtRef:
          description: >-
            Reference date the window applies to (YYYY-MM-DD), verbatim as
            announced.
          examples:
            - '2026-06-10'
          type: string
        gradeCode:
          description: >-
            Official BACEN operating-grade code, verbatim as announced by
            GEN0021.
          examples:
            - GRD01
          type: string
        opensAt:
          description: >-
            Window opening datetime, verbatim as announced (BACEN local, no
            timezone offset).
          examples:
            - '2026-06-10T06:30:00'
          type: string
        productCode:
          description: Optional BACEN product code the window applies to.
          examples:
            - '0001'
          type: string
        providerIspb:
          description: ISPB of the participant that announced the window (8 digits).
          examples:
            - 38166
          type: string
        scheduleType:
          description: BACEN schedule-type code, verbatim as announced.
          examples:
            - '1'
          type: string
        updatedAt:
          description: RFC3339 UTC timestamp of the last persisted update to this window.
          examples:
            - '2026-06-10T08:00:00Z'
          format: date-time
          type: string
      required:
        - gradeCode
        - dtRef
        - opensAt
        - closesAt
        - scheduleType
        - providerIspb
        - 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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````