Saltar al contenido principal
PUT
Set the institution's cut-off (always equal to or more conservative than the official schedule)

Autorizaciones

Authorization
string
header
requerido

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.

Encabezados

X-TTL
integer

Replay window of the idempotency key, in seconds. Default 300 (5 minutes) when missing or invalid. Values outside 30 s to 7 days are adjusted to these limits. Only the value of the FIRST request for a key counts. A change to X-TTL on retries has no effect. The window sets how long the response is replayed.

Rango requerido: x >= 1
X-Idempotency
string
requerido

Idempotency key of the change. Required: a request without it is refused with 400 TED-0011.

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.

Cuerpo

application/json

Cut-off time after which the institution stops accepting transfers for the day. Always equal to or earlier than the official close of the STR.

clientCutoffTime
string
requerido

Institution cut-off in HH:MM (local time). It cannot be later than the STR's official closing for the day.

Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
Ejemplo:

"17:00"

timezone
string

IANA time zone of the cut-off. Default: the institution's time zone.

Ejemplo:

"America/Sao_Paulo"

Respuesta

Cut-off saved and audited. The body returns today's effective window, already recalculated.

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.

date
string<date>
requerido

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

effectiveClosesAt
string<date-time>
requerido

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

effectiveOpensAt
string<date-time>
requerido

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

isBusinessDay
boolean
requerido

false on a weekend or national holiday.

isOpen
boolean
requerido

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

source
enum<string>
requerido

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

Opciones disponibles:
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).