Skip to main content
POST
Create LTR transfer (LTR0003/0004/0006)

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Idempotency key. Required on every mutation.

X-TTL
string

Idempotency key TTL in seconds.

Cuerpo

application/json
amount
string
requerido

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]?))$
Ejemplo:

"1250.00"

detail
object
requerido

The code-specific fields: the original control number, the credited account pair, the asset descriptors and the queue-preference level.

messageType
enum<string>
requerido

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.

Opciones disponibles:
LTR0003,
LTR0004,
LTR0006
Ejemplo:

"LTR0003"

traceabilityId
string
requerido

This participant's OWN control number for the entry (official ControleIF, 1-20 characters), carried verbatim as the command's NumCtrlIF — spelled NumCtrlIF_LTR on the LTR0006 wire. Reusing one already spent on the same messageType is refused as a conflict.

Required string length: 1 - 20
Ejemplo:

"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}$
Ejemplo:

"87654321"

Respuesta

Created

amountRaw
string
requerido
commandId
string
requerido
correlationId
string
requerido

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

Ejemplo:

"req-7a3f9c2e"

messageType
string
requerido
movementDate
string
requerido
numCtrlIF
string
requerido
outboundNuOp
string
requerido
Pattern: ^[0-9A-Z]{8}[0-9]{15}$
status
string
requerido