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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key. Required on every mutation.

X-TTL
string

Idempotency key TTL in seconds.

Body

application/json
amount
string
required

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

"1250.00"

detail
object
required

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

messageType
enum<string>
required

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.

Available options:
LTR0003,
LTR0004,
LTR0006
Example:

"LTR0003"

traceabilityId
string
required

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
Example:

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

"87654321"

Response

Created

amountRaw
string
required
commandId
string
required
correlationId
string
required

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

Example:

"req-7a3f9c2e"

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