Skip to main content
POST
Ask the câmara for the institution's LBTR position

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Body

application/json
movementDate
string<date>
required

The movement date (DtMovto), YYYY-MM-DD. The only required field.

cnpjNLiqdant
string

Narrow to one non-settling member.

Maximum string length: 14
identdPartCamr
string

Narrow to one câmara participant.

Maximum string length: 8
ispbIFLiqdant
string

Narrow to one COUNTERPARTY settlement bank (rule RLTR0003).

Maximum string length: 8
numCtrlLTROr
string

Narrow to one announced result.

Maximum string length: 20
numOpLTR
string

Narrow to one gross operation.

Maximum string length: 20
sitLancLTR
string

Narrow to one posting situation; numeric, carried verbatim.

Maximum string length: 3
tpDebCred
string

Narrow to debits or credits; carried verbatim.

Maximum string length: 1

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

id
string<uuid>
required

Message id.

numCtrlIF
string
required

The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two.

nuop
string
required

The BCMSG operation number of the frame.

request
any
required

The submitted request, projected verbatim.

status
enum<string>
required

Lifecycle state. REFUSED means the câmara received the message and said no; FAILED means it never reached the wire.

Available options:
SUBMITTED,
DISPATCHED,
ANSWERED,
REFUSED,
FAILED
submittedAt
string<date-time>
required

When the message was recorded.

answer
object

The câmara's answer body, verbatim. Omitted until the message is ANSWERED, and on an ANSWERED message whose body this rail does not hold — which answerAbsent then states.

answerAbsent
boolean

True only on an ANSWERED message whose answer body this rail does not hold (answered before bodies were stored). The câmara did answer; what it wrote is not here. Omitted otherwise.

answeredAt
string<date-time>

When the câmara's answer was applied; omitted until it is.

dispatchedAt
string<date-time>

When the frame reached the send queue; omitted until it has.

lastError
string

Why the last queue put failed; omitted when none has.