Skip to main content
POST
Create LDL settlement transfer (LDL0004/0006/0008/0011/0014)

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

"1250.00"

detail
object
required

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

messageType
enum<string>
required

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.

Available options:
LDL0004,
LDL0006,
LDL0008,
LDL0011,
LDL0014
Example:

"LDL0004"

traceabilityId
string
required

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

Required string length: 1 - 20
Example:

"LDLSETT0000000000001"

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