Create LDL settlement transfer (LDL0004/0006/0008/0011/0014)

Commands one of the five STR settlement transfers of the Liquidação Multilateral de Câmaras family, chosen by messageType: LDL0004 settles this participant’s DEBIT net position for a cycle (Reservas Bancárias to the câmara’s Conta de Liquidação), LDL0006 returns funds transferred in error quoting the original STR control number, LDL0008 funds the settlement of asset events and emissions, LDL0011 moves the câmara’s current account into its settlement account debiting a named branch and account, and LDL0014 funds a deposit at the câmara. The client declares the total, its own control number, and the code-specific detail — the câmara control numbers and the per-participant breakdown reach the wire VERBATIM because they originate on the SILOC leg this rail never receives, so inventing one would forge another system’s identifier. The platform SERVER-DERIVES the wire ISPBs (this participant and the câmara) and the movement date; none is client-supplied. A detail field the declared messageType does not carry is refused rather than dropped, and a control number another outbound entry already carries is refused as a conflict. The command is persisted idempotently and its signed frame enqueued for STR dispatch in the same transaction. This means dispatch was accepted, not BACEN settlement confirmation; the outcome arrives asynchronously on the code’s R1 leg. Above the client’s alçada band the frame parks (status PENDING_APPROVAL) and leaves for the STR only when the quorum signs; a denial or expiry ends it without dispatch. Idempotent — replaying the same X-Idempotency key with the same parsed request (member order and whitespace do not count; any other difference, such as number spelling, null for an absent field, or an unknown member, is another request) returns the cached response. Lerian SPB EMITS the settlement-command fact and routes settlement; the LDL cycle belongs to the câmara and the accounting position to the client’s ledger — it holds neither, and never reconciles the breakdown against the declared total.

POST /v1/str/operations/ldl-settlements

Create LDL settlement transfer (LDL0004/0006/0008/0011/0014)

cURL

curl --request POST \
  --url https://api.example.com/v1/str/operations/ldl-settlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "1250.00",
  "detail": {
    "agDebtd": "0001",
    "codProdt": "OT",
    "ctDebtd": "000000123456",
    "entries": [
      {
        "amount": "600.10",
        "cnpjNLiqdant": "12345678000195",
        "hist": "Devolucao de credito",
        "identdPartCamr": "PART0001",
        "numCtrlActeLDLOr": "ACT0000000000000001",
        "numCtrlReqIFOr": "REQ0000000000000001",
        "numPgtoLDL": "000001",
        "tpMovtc": "1",
        "tpPgtoLDL": "1"
      }
    ],
    "ispbIFCredtd": "87654321",
    "numCtrlLDLOr": "LDL000000000000001",
    "numCtrlSTROr": "20260919000000000001"
  },
  "messageType": "LDL0004",
  "traceabilityId": "LDLSETT0000000000001"
}
'

201

{
  "amountRaw": "<string>",
  "commandId": "<string>",
  "correlationId": "req-7a3f9c2e",
  "messageType": "<string>",
  "movementDate": "<string>",
  "numCtrlIF": "<string>",
  "outboundNuOp": "<string>",
  "status": "ACCEPTED"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency · string · obrigatório

Idempotency key. Required on every mutation.

X-TTL · string

Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC.

Corpo

application/json

amount · string · obrigatório

The declared total as an unsigned, non-zero decimal-reais string (at most two fractional digits). Forwarded verbatim into VlrLanc — Lerian SPB performs NO arithmetic.

Pattern: ^([1-9][0-9]{0,16}(\.[0-9]{1,2})?|0\.(0[1-9]|[1-9][0-9]?))$

Exemplo:

"1250.00"

detail · object · obrigatório

The code-specific fields: control numbers, the debited account pair, the credited counterparty of a return, and the breakdown group.

Show child attributes

messageType · enum<string> · obrigatório

Which STR settlement transfer to command: LDL0004 settles a debit net position, LDL0006 returns funds transferred in error, LDL0008 funds events and emissions, LDL0011 moves the câmara current account into its settlement account, LDL0014 funds a deposit. It decides which detail fields are required and which are refused.

Opções disponíveis: LDL0004, LDL0006, LDL0008, LDL0011, LDL0014

Exemplo:

"LDL0004"

traceabilityId · string · obrigatório

This participant's OWN control number for the entry (official ControleIF, 1-20 characters, no leading or trailing spaces), carried verbatim as the command's NumCtrlIF. Reusing one another outbound entry already carries is refused as a conflict.

Required string length: 1 - 20

Exemplo:

"LDLSETT0000000000001"

Resposta

201

application/json

Created

amountRaw · string · obrigatório

commandId · string · obrigatório

correlationId · string · obrigatório

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

Exemplo:

"req-7a3f9c2e"

messageType · string · obrigatório

movementDate · string · obrigatório

numCtrlIF · string · obrigatório

outboundNuOp · string · obrigatório

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

status · enum<string> · obrigatório

ACCEPTED when the frame was queued for the STR, PENDING_APPROVAL when the alçada band parked it awaiting signatures.

Opções disponíveis: ACCEPTED, PENDING_APPROVAL