> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /pt/openapi/v3-current/spb.yaml post /v1/str/operations/ltr-transfers
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian SPB, the direct integration between the
    institution and the Brazilian Payment System (SPB) over the National
    Financial System Network (RSFN). It covers the Reserve Transfer System
    (STR): message registry and capability catalog, operation lifecycle (bank
    transfers, IBS repasses, liquidity transfers, returns and cancellations),
    reserve-account and schedule queries, alçada governance, SME and LDL
    operations, inbound quarantine triage, reconciliation, and event delivery.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security: []
tags:
  - description: Immutable audit-record trails for STR operations and lifecycle events.
    name: Audit
  - description: >-
      STR capability catalog describing supported message types and their
      constraints.
    name: Capabilities
  - description: >-
      ICP-Brasil certificate inventory with hot-reloadable rotation and
      activation.
    name: Certificates
  - description: >-
      STR compulsory-movement (RCO) family: the movements BACEN orders on a
      participant's reserve account, their answers and the periods they belong
      to.
    name: Compulsory
  - description: >-
      Maker-checker approval queue for emissions parked above their alçada band:
      list pending, sign (approve), and deny.
    name: EmissionApprovals
  - description: Operation event catalog enumerating the emitted domain event types.
    name: Events
  - description: >-
      Inbound GEN-family notice log (GEN0001 connectivity echo, GEN0004
      transmission error, GEN0005 administrative notice).
    name: GenNotices
  - description: >-
      SPB alçada governance config: value-band table + per-message-type
      signature requirements, hot-reloaded at runtime.
    name: Governance
  - description: >-
      Read raw STR message status: list messages and read a single message by
      NUOp.
    name: Messages
  - description: Aggregated operational summaries and metrics across STR operations.
    name: OperationalIntelligence
  - description: >-
      STR operation lifecycle for bank transfers and IBS repasses, including
      returns and cancellations.
    name: Operations
  - description: >-
      Service readiness state covering startup self-probes and dependency
      health.
    name: Readiness
  - description: Reconciliation cases and the actions that resolve operation discrepancies.
    name: Reconciliation
  - description: >-
      Redesconto do Banco Central: collateralised intraday and one-business-day
      BCB lending against Selic-registered federal securities. One create door
      derives the nine RDC commands from four operator-facing kinds (contract,
      payment, conversion, cancellation), plus the two consultas over
      eligible-security prices and open positions. An accepted rediscount is not
      necessarily a settled one — Selic may hold the request for want of
      securities, and that middle state is reported as its own.
    name: Rediscounts
  - description: >-
      STR Relatórios suite: synchronous, date-ranged aggregate reports
      (movimento financeiro, transações rejeitadas, volumetria) over Lerian
      SPB's own transmission record.
    name: Reports
  - description: >-
      STR0013 reserve-account balance and STR0014 statement (extrato,
      message-mode) queries and their async results.
    name: ReserveQueries
  - description: >-
      GEN0019 participant responsável roster: full-replacement updates announced
      to BACEN.
    name: Responsibles
  - description: STR operating-window schedule governing when operations may be sent.
    name: Schedule
  - description: >-
      STR0001 single-party schedule queries (consulta de horários do STR) and
      their async STR0001R1 grid results.
    name: ScheduleQueries
  - description: >-
      STR lançamentos (SLB) family: the charges BACEN raises against this
      participant, the payments that settle them, payments to BACEN it never
      demanded, and the entry consultas over them.
    name: SLB
  - description: >-
      Reads over an IEME's conta correspondente a moeda eletrônica (CCME):
      SME0003 statement (extrato) queries and their async SME0003R1 results,
      plus the log of SME0001R2/SME0002R2/SME0004R2 movement advices the STR
      delivered about movements this rail did not command.
    name: SMEQueries
  - description: Runtime SPB configuration settings for the STR integration.
    name: Settings
  - description: >-
      Flow (mandatory order): certificate → readiness → connectivity-test →
      submit. Activate a certificate, confirm the rail reports ready, pass a
      connectivity test, then submit an operation. Each step is its own
      resource; a submit must not be attempted before readiness passes.
    name: onboarding
  - description: >-
      Flow (mandatory order): parent operation SETTLED → return/cancel. A return
      or cancellation is a sub-resource of a settled parent operation; the
      {operationId}/{endToEndID} path segment enforces the parent structurally.
    name: lifecycle
paths:
  /v1/str/operations/ltr-transfers:
    post:
      tags:
        - Operations
      summary: Create LTR transfer (LTR0003/0004/0006)
      description: >-
        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.
      operationId: createLTRTransfer
      parameters:
        - description: Idempotency key. Required on every mutation.
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: Idempotency key. Required on every mutation.
            type: string
        - description: >-
            Seconds the cached response is kept; it may only shorten
            IDEMPOTENCY_DEFAULT_TTL_SEC.
          in: header
          name: X-TTL
          schema:
            description: >-
              Seconds the cached response is kept; it may only shorten
              IDEMPOTENCY_DEFAULT_TTL_SEC.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLTRTransferRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LTRTransferAcceptedResponseWire'
          description: Created
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  true when the X-Idempotency key already holds a transfer: the
                  body is that transfer and nothing new was sent to the STR.
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '413':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Request Entity Too Large
        '415':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unsupported Media Type
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
        '504':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Gateway Timeout
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CreateLTRTransferRequest:
      additionalProperties: false
      properties:
        amount:
          description: >-
            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.
          examples:
            - '1250.00'
          pattern: ^([1-9][0-9]{0,16}(\.[0-9]{1,2})?|0\.(0[1-9]|[1-9][0-9]?))$
          type: string
        detail:
          $ref: '#/components/schemas/LTRTransferDetailRequest'
          description: >-
            The code-specific fields: the original control number, the credited
            account pair, the asset descriptors and the queue-preference level.
        ispbIFCredtd:
          description: >-
            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.
          examples:
            - '87654321'
          pattern: ^[0-9A-Z]{8}$
          type: string
        messageType:
          description: >-
            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.
          enum:
            - LTR0003
            - LTR0004
            - LTR0006
          examples:
            - LTR0003
          type: string
        traceabilityId:
          description: >-
            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.
          examples:
            - LTRXFER0000000000001
          maxLength: 20
          minLength: 1
          type: string
      required:
        - messageType
        - amount
        - traceabilityId
        - detail
      type: object
    LTRTransferAcceptedResponseWire:
      additionalProperties: false
      properties:
        amountRaw:
          type: string
        commandId:
          type: string
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          examples:
            - req-7a3f9c2e
          type: string
        messageType:
          type: string
        movementDate:
          type: string
        numCtrlIF:
          type: string
        outboundNuOp:
          pattern: ^[0-9A-Z]{8}[0-9]{15}$
          type: string
        status:
          description: >-
            ACCEPTED when the frame was queued for the STR, PENDING_APPROVAL
            when the alçada band parked it awaiting signatures.
          enum:
            - ACCEPTED
            - PENDING_APPROVAL
          type: string
      required:
        - correlationId
        - status
        - commandId
        - messageType
        - outboundNuOp
        - numCtrlIF
        - amountRaw
        - movementDate
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      required:
        - correlationId
      type: object
    LTRTransferDetailRequest:
      additionalProperties: false
      properties:
        agCredtd:
          description: >-
            Branch of the credited account at the credited institution. Optional
            on LTR0003 only, and only together with ctCredtd.
          examples:
            - '0001'
          type: string
        ctCredtd:
          description: >-
            Number of the credited account at the credited institution. Optional
            on LTR0003 only, and only together with agCredtd.
          examples:
            - '000000123456'
          type: string
        descAtv:
          description: >-
            Free-text asset description. Optional on LTR0003 and LTR0004;
            refused on LTR0006.
          examples:
            - LFT 010326
          type: string
        hist:
          description: Free-text history for the entry. Optional on all three codes.
          examples:
            - Liquidacao bilateral
          type: string
        nivelPref:
          description: >-
            Queue-preference level the STR reads when reserves are short.
            Optional on LTR0003 only.
          examples:
            - '1'
          type: string
        numCtrlLTROr:
          description: >-
            The Câmara's control number for the gross or bilateral result being
            settled, received over the SILOC leg. Required by LTR0003 and
            LTR0004; refused on LTR0006.
          examples:
            - LTR000000000000001
          type: string
        numCtrlSTROr:
          description: >-
            Control number of the ORIGINAL STR entry being returned. Required by
            LTR0006 only — it is BACEN-issued and echoed verbatim, never minted
            here.
          examples:
            - '20260921000000000001'
          type: string
        subTpAtv:
          description: >-
            Asset sub-type of the position being settled. Required by LTR0003
            and LTR0004; refused on LTR0006, which returns what was moved and
            describes no asset.
          examples:
            - '0001'
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.