Skip to main content
GET
Closing balance reported by the STR and items pending at closing

Authorizations

Authorization
string
header
required

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.

Headers

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.

Query Parameters

date
string

Reference date (YYYY-MM-DD); default = today in the institution time zone.

Response

Close of the requested date.

The day's closing balance reported by the STR and the number of transfers still pending or rejected at closing.

date
string<date>
required

Close date (YYYY-MM-DD).

reportedAt
string<date-time>
required

Timestamp (UTC) when the STR reported the closing.

closingBalance
string

Closing balance reported by the STR (BRL).

Pattern: ^(0|[1-9][0-9]{0,11})\.[0-9]{2}$
Example:

"1500.00"

pendingAtClose
integer<int64>

Transfers still pending at the close.

rejectedAtClose
integer<int64>

Transfers rejected at the close.