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

# Criar transferência de liquidez da Conta-PI

> Pré-requisito: o rail deve estar pronto antes de um envio: um certificado ativo (ver rotateCertificate, activateCertificate), um relatório de prontidão READY (ver getReadiness) e um teste de conectividade aprovado (ver createConnectivityTest). Aceita uma transferência de liquidez LPI da Conta-PI através da API centrada em operações: a direção aporte financia a Conta PI da IF a partir de seu RB/CL (a plataforma DERIVA o código de rede LPI0001), resgate recolhe fundos (LPI0003); a plataforma nunca compõe o código de rede. Persiste uma projeção de transferência de liquidez PENDING e retorna o id de operação, o status PENDING e o código de rede derivado. Isso significa que o despacho foi aceito, não uma confirmação de liquidação do BACEN; a liquidação chega de forma assíncrona na R-leg de entrada do STR e é lida via getLiquidityTransfer. Um aporte fora da janela é rejeitado (RLPI0007). O Lerian SPB EMITE o fato de movimento e projeta o saldo da Conta-PI de forma literal; nunca calcula uma posição. Idempotente: reenviar a mesma chave X-Idempotency com o mesmo corpo retorna a resposta em cache.



## OpenAPI

````yaml pt/openapi/v3-current/spb.yaml post /v1/str/operations/liquidity-transfers
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interface OpenAPI 3.1 do Lerian SPB, a integração direta entre a instituição
    e o Sistema de Pagamentos Brasileiro (SPB) sobre a Rede do Sistema
    Financeiro Nacional (RSFN). Abrange o Sistema de Transferência de Reservas
    (STR): registro de mensagens e catálogo de capacidades, ciclo de vida das
    operações (transferências bancárias, repasses IBS, transferências de
    liquidez, devoluções e cancelamentos), consultas de conta de reservas e de
    horários, governança de alçada, conciliação e entrega de eventos.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://spb.sandbox.lerian.net
security: []
tags:
  - description: >-
      Trilhas imutáveis de registros de auditoria para operações STR e eventos
      de ciclo de vida.
    name: Audit
  - description: >-
      Catálogo de capacidades STR que descreve os tipos de mensagem suportados e
      suas restrições.
    name: Capabilities
  - description: >-
      Inventário de certificados ICP-Brasil com rotação e ativação recarregáveis
      a quente.
    name: Certificates
  - description: >-
      Fila de aprovação maker-checker para emissões retidas acima de sua banda
      de alçada: listar pendentes, assinar (aprovar) e negar.
    name: EmissionApprovals
  - description: >-
      Registros de entrega de eventos por webhook com controle de retentativas
      para despachos falhos.
    name: EventDeliveries
  - description: >-
      Catálogo de eventos de operação que enumera os tipos de evento de domínio
      emitidos.
    name: Events
  - description: >-
      Registro de avisos recebidos da família GEN (GEN0001 eco de conectividade,
      GEN0004 erro de transmissão, GEN0005 aviso administrativo).
    name: GenNotices
  - description: >-
      Governança de alçada do SPB: a tabela de bandas de valor e os requisitos
      de assinatura por tipo de mensagem, recarregados a quente em tempo de
      execução.
    name: Governance
  - description: >-
      Estado bruto das mensagens STR: listar as mensagens e ler uma mensagem
      individual por NUOp.
    name: Messages
  - description: Resumos e métricas operacionais agregados das operações STR.
    name: OperationalIntelligence
  - description: >-
      Ciclo de vida das operações STR para transferências bancárias e repasses
      IBS, incluindo devoluções e cancelamentos.
    name: Operations
  - description: >-
      Estado de prontidão do serviço que abrange as autoverificações de
      inicialização e a saúde das dependências.
    name: Readiness
  - description: Casos de conciliação e as ações que resolvem as divergências de operação.
    name: Reconciliation
  - description: >-
      Suíte de relatórios STR: relatórios agregados síncronos por intervalo de
      datas (movimento financeiro, transações rejeitadas, volumetria) sobre o
      próprio registro de transmissão do Lerian SPB.
    name: Reports
  - description: >-
      Consultas de saldo de conta de reservas STR0013 e de extrato STR0014 (modo
      mensagem) e seus resultados assíncronos.
    name: ReserveQueries
  - description: >-
      Lista de responsáveis do participante GEN0019: atualizações de
      substituição total anunciadas ao BACEN.
    name: Responsibles
  - description: >-
      Programação de janelas de operação do STR que rege quando as operações
      podem ser enviadas.
    name: Schedule
  - description: >-
      Consultas de horários STR0001 de parte única (consulta de horários do STR)
      e seus resultados de grade STR0001R1 assíncronos.
    name: ScheduleQueries
  - description: Configurações de tempo de execução do SPB para a integração STR.
    name: Settings
  - description: >-
      Registro e gerenciamento de endpoints de webhook para a entrega de
      eventos.
    name: Webhooks
  - description: >-
      Fluxo (ordem obrigatória): certificado → prontidão →
      teste-de-conectividade → envio. Ative um certificado, confirme que o rail
      reporta prontidão, passe em um teste de conectividade e então envie uma
      operação. Cada etapa é seu próprio recurso; um envio não deve ser tentado
      antes de a prontidão passar.
    name: onboarding
  - description: >-
      Fluxo (ordem obrigatória): operação pai SETTLED → devolução/cancelamento.
      Uma devolução ou cancelamento é um sub-recurso de uma operação pai
      liquidada; o segmento de rota {operationId}/{endToEndID} impõe o pai
      estruturalmente.
    name: lifecycle
paths:
  /v1/str/operations/liquidity-transfers:
    post:
      tags:
        - Operations
        - onboarding
      summary: Criar transferência de liquidez da Conta-PI
      description: >-
        Pré-requisito: o rail deve estar pronto antes de um envio: um
        certificado ativo (ver rotateCertificate, activateCertificate), um
        relatório de prontidão READY (ver getReadiness) e um teste de
        conectividade aprovado (ver createConnectivityTest). Aceita uma
        transferência de liquidez LPI da Conta-PI através da API centrada em
        operações: a direção aporte financia a Conta PI da IF a partir de seu
        RB/CL (a plataforma DERIVA o código de rede LPI0001), resgate recolhe
        fundos (LPI0003); a plataforma nunca compõe o código de rede. Persiste
        uma projeção de transferência de liquidez PENDING e retorna o id de
        operação, o status PENDING e o código de rede derivado. Isso significa
        que o despacho foi aceito, não uma confirmação de liquidação do BACEN; a
        liquidação chega de forma assíncrona na R-leg de entrada do STR e é lida
        via getLiquidityTransfer. Um aporte fora da janela é rejeitado
        (RLPI0007). O Lerian SPB EMITE o fato de movimento e projeta o saldo da
        Conta-PI de forma literal; nunca calcula uma posição. Idempotente:
        reenviar a mesma chave X-Idempotency com o mesmo corpo retorna a
        resposta em cache.
      operationId: createLiquidityTransferOperation
      parameters:
        - description: Bearer JWT token.
          in: header
          name: Authorization
          schema:
            description: Bearer JWT token.
            type: string
        - description: Idempotency key (canonical; legacy alias X-Idempotency-Key).
          in: header
          name: X-Idempotency
          schema:
            description: Idempotency key (canonical; legacy alias X-Idempotency-Key).
            type: string
        - description: Idempotency key (legacy alias).
          in: header
          name: X-Idempotency-Key
          schema:
            description: Idempotency key (legacy alias).
            type: string
        - description: Idempotency key TTL in seconds.
          in: header
          name: X-TTL
          schema:
            description: Idempotency key TTL in seconds.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLiquidityTransferRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiquidityTransferAcceptedResponse'
          description: Accepted
          links:
            prerequisite:
              description: >-
                Onboarding prerequisite: the rail readiness reported by
                getReadiness must be READY before a submit is accepted.
              operationId: getReadiness
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CreateLiquidityTransferRequest:
      additionalProperties: false
      properties:
        accountType:
          description: >-
            Counterparty account type. RB_CL = Reservas Bancárias / Conta de
            Liquidação ((aporte,RB_CL)->LPI0001, (resgate,RB_CL)->LPI0003); CCME
            = Conta Correspondente a Moeda Eletrônica, own-account only
            ((aporte,CCME)->LPI0002, (resgate,CCME)->LPI0004). Empty defaults to
            RB_CL.
          examples:
            - RB_CL
          type: string
        amount:
          description: >-
            Movement amount as a decimal-reais string, forwarded verbatim into
            the LPI submit — Lerian SPB performs NO arithmetic on it.
          examples:
            - '1500.25'
          pattern: ^[0-9]+(\.[0-9]+)?$
          type: string
        contaPiISPB:
          description: >-
            Optional Conta-PI owner ISPB (8 digits). Empty means the FI's OWN
            Conta PI (own-account path); a value differing from the issuer ISPB
            is the liquidante-funded path (RB_CL only). For CCME it must be
            empty or equal the issuer ISPB — CCME is own-account only.
          examples:
            - 38166
          pattern: ^[0-9]{8}$
          type: string
        direction:
          description: >-
            Operator-facing movement direction: aporte funds the FI's Conta PI;
            resgate recalls funds from Conta PI.
          examples:
            - aporte
          type: string
      required:
        - direction
        - amount
      type: object
    LiquidityTransferAcceptedResponse:
      additionalProperties: false
      properties:
        operationId:
          description: >-
            Server-assigned operation UUID to poll on GET
            /v1/str/operations/liquidity-transfers/{operationId}.
          examples:
            - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          format: uuid
          type: string
        status:
          description: >-
            Projection lifecycle status; PENDING on accept (awaiting the STR
            R-leg settlement confirmation).
          examples:
            - PENDING
          type: string
        wireCode:
          description: >-
            LPI wire code derived server-side from (direction, accountType):
            (aporte,RB_CL)=LPI0001, (aporte,CCME)=LPI0002,
            (resgate,RB_CL)=LPI0003, (resgate,CCME)=LPI0004.
          examples:
            - LPI0001
          type: string
      required:
        - operationId
        - status
        - wireCode
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````