Skip to main content
POST
Confirm or reject a settlement between two non-settling members

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
decidedAt
string<date-time>
required

The deciding institution's own clock (DtHrIF).

movementDate
string<date>
required

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

numCtrlLTROr
string
required

The câmara's control number on the LTR0007 being answered (NumCtrlLTROr).

Required string length: 1 - 20
tpConfDivg
string
required

Tipo Confirma ou Diverge, one character, carried to the wire verbatim.

Required 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.