Skip to main content
GET
List third-party compulsory deposits

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

creditedISPB
string

Filter by credited institution.

Pattern: ^[0-9A-Z]{8}$
startDate
string

Inclusive window start over the time this rail RECEIVED the advice (RFC3339 or YYYY-MM-DD).

endDate
string

Inclusive window end. A bare date spans the whole day.

limit
integer<int64>

Page size (clamped server-side).

Intervalo obrigatório: 1 <= x <= 100
cursor
string

Opaque continuation token from a previous page.

Resposta

OK

correlationId
string
obrigatório

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Exemplo:

"req-7a3f9c2e"

items
object[]
obrigatório

Announced third-party deposits, newest first. Always an array.

nextCursor
string