Skip to main content
GET
List commanded compulsory movements

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

kind
enum<string>

Filter by direction.

Available options:
withdrawal,
deposit
status
enum<string>

Filter by lifecycle class.

Available options:
PENDING,
SETTLED,
REJECTED,
CANCELED
movementDate
string

Filter by DtMovto, matched EXACTLY as BACEN spells it. Not a range: the column is wire text carried verbatim, so a range would impose this rail's calendar on a third party's format.

limit
integer<int64>

Page size (clamped server-side).

Required range: 1 <= x <= 100
cursor
string

Opaque continuation token from a previous page.

Response

OK

correlationId
string
required

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

Example:

"req-7a3f9c2e"

items
object[]
required

Commanded movements, newest first. Always an array.

nextCursor
string

Continuation token, absent on the last page.