Skip to main content
POST
Submit STR0001 schedule query

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Authorization
string

Bearer JWT token.

X-Idempotency
string

Idempotency key (canonical; legacy alias X-Idempotency-Key).

X-Idempotency-Key
string

Idempotency key (legacy alias).

X-TTL
string

Idempotency key TTL in seconds.

Body

application/json
dtRef
string
required

Reference date (Data Referência, DtRef) the STR schedule grid is requested for. Required.

Example:

"2026-06-15"

ispbIf
string
required

ISPB of the querying financial institution (8 numeric digits).

Example:

"12345678"

tpHrio
string

Schedule type (Tipo Horário): P (padrão/standard) or E (eventual). Optional — absent returns both standard and eventual grids in force on DtRef (RSTR0001/0002/0003).

Example:

"P"

Response

Accepted

correlationId
string
required

Request-scoped correlation identifier echoing X-Request-ID.

Example:

"req-7a3f9c2e"

dtRef
string
required

Reference date the schedule grid was requested for.

Example:

"2026-06-15"

id
string
required

Correlation id (the outbound STR0001 NUOp). Poll GET /v1/str/schedule-queries/{id} for the answer.

Example:

"12345678202606150000001"

ispbIf
string
required

ISPB of the querying financial institution.

Example:

"12345678"

status
string
required

Projection state: PENDING until the STR0001R1 answer arrives and is projected.

Example:

"PENDING"

submittedAt
string
required

RFC3339 UTC timestamp the STR0001 query was persisted before send.

Example:

"2026-06-15T12:00:00Z"