> ## 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. # Get the settlement grid this process is enforcing > Returns the settlement schedule this pod is applying at the instant of the request: every window of the grid with its nominal boundaries, modeled STR cutoff and current phase, plus the EFFECTIVE credit dispatch posture — which gate the pod applies (the configured v0 credit window, the opt-in grid gate, or the dev always-open relaxation), under which Núclea special grade, and over which boundaries. The credit dispatch block is the authoritative answer for outbound credit: the enforced credit window is NOT in the grid unless the grid gate is enabled, so a grid-only reading can name hours the pod does not apply. All instants are RFC3339 UTC; date and the window boundaries are the LOCAL São Paulo day. Window boundaries are the published grade and are reported even on a weekend or holiday, where businessDay is false and nextOpenAt names the next business opening. Takes no parameters: the phases are defined at an instant, and the grid is a global process object with no tenant or participant dimension. RBAC: schedule:read (non-tenant). ## OpenAPI ````yaml /es/openapi/v3-current/slc.yaml get /v1/schedule openapi: 3.1.0 info: description: >- API for Lerian SLC — the participant-side rail that connects the institution to Núclea's SLC card settlement. title: Lerian SLC API version: 1.0.0 servers: - url: https://slc.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Settlement operation lifecycle — create, list, query, and control the NUliquid-tracked card operations (NUliquid = the 21-position id Núclea assigns each accepted operation) through the state machine. name: Operations - description: >- Participant catalog — the acquirers, sub-acquirers, IF Domicílio (bank where the merchant receives its sales), and settlement FIs (financial institutions) that take part in card settlement. name: Participants - description: >- Card arrangements (bandeira/scheme configurations, e.g. Visa/Master/Elo) attached to a participant. name: Arrangements - description: >- Regulated transport orchestration to Núclea's SLC — dispatch, recovery, retransmission, and connectivity testing over managed file-transfer, message-broker, and REST. name: Connectivity - description: >- Multilateral netting clearing positions — the net amount each participant settles per STR cycle (STR = Banco Central reserves-transfer system). name: Clearing - description: >- SaaS BYOK (Bring Your Own Key) signing-key provisioning — import parameters and register the client's ICP-Brasil server-type certificate material used to sign ASLC files (RSA, at least 2048 bits, and valid at the moment of import — all three are enforced); the SLC never receives the private key in cleartext. name: SigningKey - description: >- ASLC file intake and status — passthrough submission and processing status of the official Núclea card-settlement XML files (ASLC = Arquivo do Sistema de Liquidação de Cartões). name: Files - description: >- Read-only introspection of the embedded Núclea ASLC/RSFN (National Financial System Network) XSD schemas used to validate outbound and inbound messages. name: XSD Schemas - description: Read-only regulatory, compliance, and operational settlement reports. name: Reports - description: >- Outbound business-event webhook subscriptions and delivery management for consumers (client ledgers — optional). name: Webhooks - description: >- Administrative operations — hot-reloadable runtime configuration, dead-letter-queue inspection/replay, and outbox redispatch. name: Admin paths: /v1/schedule: get: tags: - Schedule summary: Get the settlement grid this process is enforcing description: >- Returns the settlement schedule this pod is applying at the instant of the request: every window of the grid with its nominal boundaries, modeled STR cutoff and current phase, plus the EFFECTIVE credit dispatch posture — which gate the pod applies (the configured v0 credit window, the opt-in grid gate, or the dev always-open relaxation), under which Núclea special grade, and over which boundaries. The credit dispatch block is the authoritative answer for outbound credit: the enforced credit window is NOT in the grid unless the grid gate is enabled, so a grid-only reading can name hours the pod does not apply. All instants are RFC3339 UTC; date and the window boundaries are the LOCAL São Paulo day. Window boundaries are the published grade and are reported even on a weekend or holiday, where businessDay is false and nextOpenAt names the next business opening. Takes no parameters: the phases are defined at an instant, and the grid is a global process object with no tenant or participant dimension. RBAC: schedule:read (non-tenant). operationId: getSchedule responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleResponse' description: OK '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '501': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Not Implemented: this capability is not part of this deployment. Operations are registered unconditionally so the published contract is identical across deploy shapes; when the capability behind one did not compose here (authentication disabled, no database, no outbound transport, or the feature switched off) it answers this coded SLC-0012 problem. It is definitive for this deployment: retrying does not help, and the `detail` is deliberately scrubbed (any status >= 500 is). default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: ScheduleResponse: additionalProperties: false properties: businessDay: description: >- True when the bank calendar considers this date a settlement business day. False on a weekend or holiday, where the window boundaries below still name the published grade hours but nothing is dispatched in them — read nextOpenAt to disambiguate. examples: - true type: boolean creditDispatch: $ref: '#/components/schemas/ScheduleCreditDispatchResponse' description: >- The EFFECTIVE credit dispatch posture: which gate this pod applies and over which window. The enforced credit window is not necessarily in the grid below, so this is the authoritative answer for outbound credit. date: description: >- Local São Paulo calendar date (YYYY-MM-DD) the grid was evaluated on. It is the LOCAL date, not the UTC one: the two disagree for three hours every night, which is exactly when a settlement day rolls over. examples: - '2026-07-15' type: string timezone: description: >- IANA name of the RESOLVED zone the boundaries were computed in. Normally America/Sao_Paulo; a UTC value denounces that the zone database was unavailable and every hour below is three hours off. examples: - America/Sao_Paulo type: string windows: description: >- Every window of the grid, ordered by opensAt ascending with a name ascending tie-break. Always an array — an empty grid serializes as [], never null. items: $ref: '#/components/schemas/ScheduleWindowResponse' type: array required: - date - businessDay - timezone - creditDispatch - windows type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string correlationId: description: Request-scoped correlation identifier echoing X-Request-ID. examples: - req-7a3f9c2e 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. required: - correlationId type: object ScheduleCreditDispatchResponse: additionalProperties: false properties: closesAt: description: >- Close boundary of that same instance (RFC3339 UTC). It lands on D+1 under Grade Especial 1, whose credit leg runs 03h00 D0 to 05h30 D+1 (INFO-NÚCLEA-SLC 009-2026 §4.1.b); it is reported verbatim, never wrapped back into the day. examples: - '2026-07-15T20:30:00Z' format: date-time type: string gate: description: >- Which gate this pod applies. V0_CREDIT_WINDOW is the default: the single daily SCHEDULE_CREDIT_WINDOW_OPEN/_CLOSE window, evaluated against the settlement calendar — weekends, plus the dates configured in SCHEDULE_HOLIDAYS. GRID is the opt-in posture over the grid's FIXED CREDIT_DISPATCH_CYCLE_1 hours, which never read SCHEDULE_CREDIT_WINDOW_*. Both consult the same calendar; they differ in WHICH window applies. DEV_ALWAYS_OPEN is the dev-only relaxation, consulting neither clock nor calendar, unreachable under production/SaaS. enum: - V0_CREDIT_WINDOW - GRID - DEV_ALWAYS_OPEN examples: - V0_CREDIT_WINDOW type: string nextOpenAt: description: >- Next instant the reported window opens (RFC3339 UTC). It is what makes a CLOSED posture legible: opensAt/closesAt keep naming the day's hours even after they elapsed. Under GRID and under V0_CREDIT_WINDOW alike it is rolled by the settlement calendar to the next business day, so it never names a weekend nor a date configured in SCHEDULE_HOLIDAYS. That list is the WHOLE holiday source — it has no default, so a deployment that leaves it empty gets weekend closure only and this instant can name a national holiday; under DEV_ALWAYS_OPEN it names the CONFIGURED window's next opening with no calendar at all, because that gate consults none. examples: - '2026-07-16T03:30:00Z' format: date-time type: string opensAt: description: >- Open boundary of the window INSTANCE the reported gate is applying (RFC3339 UTC). Normally this request's local day; for a cross-midnight window still running from the previous day it is that day's boundary, because that is the instance state describes. So while state is OPEN the invariant opensAt <= now < closesAt holds — except under DEV_ALWAYS_OPEN, whose OPEN belongs to the gate and not to the window. examples: - '2026-07-15T03:30:00Z' format: date-time type: string specialGrade: description: >- Active Núclea grade (SCHEDULE_SPECIAL_GRADE). Reported under every gate: a special grade and the grid gate are mutually exclusive at boot, so 'none' next to GRID is the honest answer rather than a missing one. enum: - none - especial1 - especial2 examples: - none type: string state: description: >- Phase at this instant, taken from the same predicate the dispatch gate reads. Under DEV_ALWAYS_OPEN it is always OPEN, because that is what the gate answers at every instant. enum: - OPEN - PRE_CUTOFF - CLOSED examples: - OPEN type: string required: - gate - specialGrade - opensAt - closesAt - state - nextOpenAt type: object ScheduleWindowResponse: additionalProperties: false properties: closesAt: description: >- This day's local close boundary (RFC3339 UTC). D+1 whenever the close offset exceeds 24h. examples: - '2026-07-15T10:50:00Z' format: date-time type: string cutoffAt: description: >- This day's modeled STR cutoff (RFC3339 UTC), or null on a window that models no cutoff — the seven submission/receipt windows, which are never PRE_CUTOFF. examples: - '2026-07-15T10:50:00Z' format: date-time type: - string - 'null' name: description: >- The window kind, verbatim — the same literal the dispatch gates key on. examples: - CREDIT_DISPATCH_CYCLE_1 type: string nextOpenAt: description: >- Next instant this window opens (RFC3339 UTC), rolled by the settlement calendar to the next business day, so it never names a weekend nor a date configured in SCHEDULE_HOLIDAYS. That list is the whole holiday source and has no default: with it empty the calendar is weekends only. examples: - '2026-07-16T03:30:00Z' format: date-time type: string opensAt: description: >- This day's local open boundary (RFC3339 UTC). Reported even on a non-business day. examples: - '2026-07-15T03:30:00Z' format: date-time type: string state: description: >- Phase at this instant, verbatim from the window — the same value the dispatch gate reads, never a second opinion. PRE_CUTOFF means dispatch is still permitted but the cutoff is within the alert lead. enum: - OPEN - PRE_CUTOFF - CLOSED examples: - CLOSED type: string required: - name - opensAt - closesAt - cutoffAt - state - nextOpenAt 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 ````