Create LTR transfer (LTR0003/0004/0006)

Commands one of the three STR-addressed transfers of the Liquidação Bruta ou Bilateral de Operações family, chosen by messageType: LTR0003 moves Reservas Bancárias to another institution and has the STR notify the Câmara, LTR0004 settles this participant’s negotiation result into the Câmara’s account, and LTR0006 returns funds transferred in error quoting the original STR control number. The client declares the amount, its own control number, the credited institution where the code names one, and the code-specific detail — the Câmara control number reaches the wire VERBATIM because it originates 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, as is an LTR0004 whose câmara result (numCtrlLTROr at that câmara) already has an LTR0004 accepted, pending, awaiting confirmation or settled; a rejected or cancelled one, or one the câmara returned whole by LTR0006, leaves the result payable. 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, where only an Efetivado status emits a settled fact — the bilateral confirmation states 50/51/52 emit nothing. 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 routes settlement and emits the terminal fact; the LBTR obligation belongs to the Câmara and the accounting position to the client’s ledger — it holds neither.

POST /v1/str/operations/ltr-transfers

Create LTR transfer (LTR0003/0004/0006)

cURL

curl --request POST \
  --url https://api.example.com/v1/str/operations/ltr-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "amount": "1250.00",
  "detail": {
    "agCredtd": "0001",
    "ctCredtd": "000000123456",
    "descAtv": "LFT 010326",
    "hist": "Liquidacao bilateral",
    "nivelPref": "1",
    "numCtrlLTROr": "LTR000000000000001",
    "numCtrlSTROr": "20260921000000000001",
    "subTpAtv": "0001"
  },
  "messageType": "LTR0003",
  "traceabilityId": "LTRXFER0000000000001",
  "ispbIFCredtd": "87654321"
}
'

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 amount 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: the original control number, the credited account pair, the asset descriptors and the queue-preference level.

Show child attributes

messageType · enum<string> · obrigatório

Which STR transfer to command: LTR0003 moves Reservas Bancárias to another institution and has the STR notify the Câmara, LTR0004 settles this participant's negotiation result into the Câmara's account, LTR0006 returns funds transferred in error. It decides which detail fields are required and which are refused.

Opções disponíveis: LTR0003, LTR0004, LTR0006

Exemplo:

"LTR0003"

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 — spelled NumCtrlIF_LTR on the LTR0006 wire. Reusing one another outbound entry already carries is refused as a conflict.

Required string length: 1 - 20

Exemplo:

"LTRXFER0000000000001"

ispbIFCredtd · string

ISPB of the credited institution. Required by LTR0003 and LTR0006; refused on LTR0004, whose layout names the câmara as the destination and no credited institution at all. This participant is always the debited side and its own ISPB is server-derived.

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

Exemplo:

"87654321"

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