Skip to main content
POST
Withdraw balance from the settlement account

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
DtMovto
string
required

Data Movimento (xs:date, [1..1]).

TpDev
string
required

Tipo Devolução (TpDev, [1..1]): TOT (everything the participant may withdraw), LIM (at most VlrLimDev) or VAL (exactly VlrLimDev). LIM and VAL require VlrLimDev.

VlrLimDev
string

Valor Limite Devolução (Valor, [0..1]): the amount LIM bounds and VAL names exactly. Normally omitted for TOT, where the câmara determines the total; if sent, it is written to the wire as given.

Response

Accepted

attempts
integer<int64>
required

Queue-put attempts made so far.

codMsg
string
required

The SFN command code this row carries, e.g. LDL0003.

id
string<uuid>
required

Outbound 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
object
required

The request exactly as it was submitted, projected verbatim.

status
enum<string>
required

Lifecycle state. REFUSED means the câmara received the command and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts. LDL1019 has no positive answer leg in the Catálogo, so an accepted LDL1019 stays DISPATCHED: delivered, and no reply is owed.

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

When the command was recorded.

answer
object

What the câmara answered; omitted until it has answered, and never present for LDL1019, which has no answer leg.

answerAbsent
boolean

True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. 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, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies.