Skip to main content
GET
Get the settlement grid this process is enforcing

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Response

OK

businessDay
boolean
required

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.

Example:

true

creditDispatch
object
required

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
string
required

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.

Example:

"2026-07-15"

timezone
string
required

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.

Example:

"America/Sao_Paulo"

windows
object[]
required

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.