Get the effective window (official schedule ⊕ cut-off ⊕ calendar) and the configured cut-off

Returns the operating window of a day, that is, when the institution accepts TED send requests. It combines the official STR schedule, the institution cut-off, and the holiday calendar. isOpen tells if the window is open now. source tells what decided the result (schedule, schedule with cut-off, holiday, or weekend).

Outside the window, a send request returns 422 TED-0020. On a non-business day, it returns 422 TED-0021. If the schedule is unavailable, or the holiday calendar does not cover the date, it returns 503 TED-0022. When the STR has not published the customer-transfer schedule for the date, TED-0022 carries the detail “The STR has not published the customer-transfer schedule for the requested date, so the operating window cannot be determined.” When the schedule could not be read from the rail, it carries “The STR schedule could not be read from the rail, so the operating window cannot be determined. Retry later; if it persists, the institution’s rail connection needs operator attention.” Give date for another day; times are in UTC.

GET /v1/policy/window

Get the effective window (official schedule ⊕ cut-off ⊕ calendar) and the configured cut-off

cURL

curl --request GET \
  --url https://api.example.com/v1/policy/window \
  --header 'Authorization: Bearer <token>'

200

{
  "clientCutoffTime": "17:00",
  "configured": true,
  "date": "2026-10-22",
  "effectiveClosesAt": "2026-10-22T20:00:00Z",
  "effectiveOpensAt": "2026-10-22T09:30:00Z",
  "isBusinessDay": true,
  "isOpen": true,
  "officialClosesAt": "2026-10-22T20:30:00Z",
  "source": "OFFICIAL_SCHEDULE_WITH_CUTOFF"
}

Autorizações

Authorization · string · header · obrigatório

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Cabeçalhos

X-Request-Id · string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Parâmetros de consulta

date · string<date>

Reference date (YYYY-MM-DD). Default: today in the institution time zone.

Resposta

200

application/json

Effective window for the requested date (today by default).

Effective operating window of a day: the official STR schedule, narrowed by the institution cut-off and the holiday calendar. Outside it, send requests are refused with TED-0020/TED-0021.

configured · boolean · obrigatório

true when a stored window configuration (of the organization, or the institution default) decided this window; false when no configuration exists and the window follows the official STR schedule with no cut-off.

date · string<date> · obrigatório

Calendar day that this window describes (YYYY-MM-DD).

effectiveClosesAt · string<date-time> · obrigatório

Effective close (UTC): the earlier of the official STR close and the institution cut-off.

effectiveOpensAt · string<date-time> · obrigatório

Effective opening of the window in the day (UTC).

isBusinessDay · boolean · obrigatório

false on a weekend or national holiday.

isOpen · boolean · obrigatório

If the window is open at the time of the query.

source · enum<string> · obrigatório

What decided the response: OFFICIAL_SCHEDULE (official schedule), OFFICIAL_SCHEDULE_WITH_CUTOFF (schedule narrowed by the cut-off), HOLIDAY, or WEEKEND.

Opções disponíveis: OFFICIAL_SCHEDULE, OFFICIAL_SCHEDULE_WITH_CUTOFF, HOLIDAY, WEEKEND

clientCutoffTime · string

Cut-off configured by the institution (HH:MM, local time). Missing when there is no cut-off.

officialClosesAt · string<date-time>

Official close of the STR (UTC). Missing on a day with no published schedule (weekend, holiday).