> ## 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 Conta-PI liquidity transfer

> Prerequisite: the rail must be ready before a submit — an active certificate (see rotateCertificate, activateCertificate), a READY readiness report (see getReadiness), and a passing connectivity test (see createConnectivityTest). Accepts an LPI Conta-PI liquidity transfer through the operation-centric API: direction aporte funds the FI's Conta PI from its RB/CL (the platform DERIVES wire code LPI0001), resgate recalls funds (LPI0003) — the platform never composes the wire code. Persists a PENDING liquidity-transfer projection and returns the operation id, the PENDING status, and the derived wire code. This means dispatch was accepted, not BACEN settlement confirmation; the settlement arrives asynchronously on the inbound STR R-leg and is read via getLiquidityTransfer. An out-of-window aporte is rejected (RLPI0007). Lerian SPB EMITS the movement fact and projects the Conta-PI balance verbatim; it never computes a position. Idempotent — replaying the same X-Idempotency key with the same body returns the cached response.



## OpenAPI

````yaml en/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: >-
    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, reconciliation, and
    event delivery.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://spb.sandbox.lerian.net
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: >-
      Maker-checker approval queue for emissions parked above their alçada band:
      list pending, sign (approve), and deny.
    name: EmissionApprovals
  - description: Webhook event-delivery records with retry control for failed dispatches.
    name: EventDeliveries
  - 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: the value-band table and 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: >-
      STR reports suite: synchronous, date-ranged aggregate reports (financial
      movement, rejected transactions, 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: Runtime SPB configuration settings for the STR integration.
    name: Settings
  - description: Webhook endpoint registration and management for event delivery.
    name: Webhooks
  - 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/liquidity-transfers:
    post:
      tags:
        - Operations
        - onboarding
      summary: Create Conta-PI liquidity transfer
      description: >-
        Prerequisite: the rail must be ready before a submit — an active
        certificate (see rotateCertificate, activateCertificate), a READY
        readiness report (see getReadiness), and a passing connectivity test
        (see createConnectivityTest). Accepts an LPI Conta-PI liquidity transfer
        through the operation-centric API: direction aporte funds the FI's Conta
        PI from its RB/CL (the platform DERIVES wire code LPI0001), resgate
        recalls funds (LPI0003) — the platform never composes the wire code.
        Persists a PENDING liquidity-transfer projection and returns the
        operation id, the PENDING status, and the derived wire code. This means
        dispatch was accepted, not BACEN settlement confirmation; the settlement
        arrives asynchronously on the inbound STR R-leg and is read via
        getLiquidityTransfer. An out-of-window aporte is rejected (RLPI0007).
        Lerian SPB EMITS the movement fact and projects the Conta-PI balance
        verbatim; it never computes a position. Idempotent — replaying the same
        X-Idempotency key with the same body returns the cached response.
      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

````