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

# Configurar la transferencia automática de la Conta-PI

> Prerrequisito: el rail debe estar listo antes de un envío: un certificado activo (ver rotateCertificate, activateCertificate), un reporte de disponibilidad READY (ver getReadiness) y una prueba de conectividad aprobada (ver createConnectivityTest). Declara la política de transferencia automática del STR por clase de cuenta (la plataforma emite el código de red LPI0005): para CADA clase (RB/CL y CCME) establece exactamente UNO de {percent, value}; un valor de '0'/'0.00' desactiva la transferencia automática para esa clase. 'Gana el último mensaje': una nueva configuración reemplaza por completo la anterior. Persiste la última trama de configuración enviada y devuelve el código de red derivado, el estado de envío y el NUOp. Esto significa que el despacho fue aceptado, no una confirmación de BACEN; el STR reconoce de forma asíncrona (LPI0005R1) y más tarde reporta cada transferencia automática que realiza (LPI0006). Lerian SPB reenvía los valores de configuración de forma literal; NO realiza ninguna aritmética. Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché.



## OpenAPI

````yaml es/openapi/v3-current/spb.yaml post /v1/str/operations/auto-transfer-config
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interfaz OpenAPI 3.1 de Lerian SPB, la integración directa entre la
    institución y el Sistema de Pagos Brasileño (SPB) sobre la Red del Sistema
    Financiero Nacional (RSFN). Cubre el Sistema de Transferencia de Reservas
    (STR): registro de mensajes y catálogo de capacidades, ciclo de vida de las
    operaciones (transferencias bancarias, repasses IBS, transferencias de
    liquidez, devoluciones y cancelaciones), consultas de cuenta de reservas y
    de horarios, gobernanza de alçada, conciliación y 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: >-
      Rastros inmutables de registros de auditoría para operaciones STR y
      eventos de ciclo de vida.
    name: Audit
  - description: >-
      Catálogo de capacidades STR que describe los tipos de mensaje admitidos y
      sus restricciones.
    name: Capabilities
  - description: >-
      Inventario de certificados ICP-Brasil con rotación y activación
      recargables en caliente.
    name: Certificates
  - description: >-
      Cola de aprobación maker-checker para emisiones retenidas por encima de su
      banda de alçada: listar pendientes, firmar (aprobar) y denegar.
    name: EmissionApprovals
  - description: >-
      Registros de entrega de eventos por webhook con control de reintentos para
      despachos fallidos.
    name: EventDeliveries
  - description: >-
      Catálogo de eventos de operación que enumera los tipos de evento de
      dominio emitidos.
    name: Events
  - description: >-
      Registro de avisos entrantes de la familia GEN (GEN0001 eco de
      conectividad, GEN0004 error de transmisión, GEN0005 aviso administrativo).
    name: GenNotices
  - description: >-
      Gobernanza de alçada del SPB: la tabla de bandas de valor y los requisitos
      de firma por tipo de mensaje, recargados en caliente en tiempo de
      ejecución.
    name: Governance
  - description: >-
      Estado crudo de los mensajes STR: listar los mensajes y leer un mensaje
      individual por NUOp.
    name: Messages
  - description: Resúmenes y métricas operativas agregadas de las operaciones STR.
    name: OperationalIntelligence
  - description: >-
      Ciclo de vida de las operaciones STR para transferencias bancarias y
      repasses IBS, incluyendo devoluciones y cancelaciones.
    name: Operations
  - description: >-
      Estado de disponibilidad del servicio que abarca las autopruebas de
      arranque y la salud de las dependencias.
    name: Readiness
  - description: >-
      Casos de conciliación y las acciones que resuelven las discrepancias de
      operación.
    name: Reconciliation
  - description: >-
      Suite de reportes STR: reportes agregados síncronos por rango de fechas
      (movimiento financiero, transacciones rechazadas, volumetria) sobre el
      propio registro de transmisión de Lerian SPB.
    name: Reports
  - description: >-
      Consultas de saldo de cuenta de reservas STR0013 y de extrato STR0014
      (modo mensaje) y sus resultados asíncronos.
    name: ReserveQueries
  - description: >-
      Lista de responsáveis del participante GEN0019: actualizaciones de
      reemplazo total anunciadas a BACEN.
    name: Responsibles
  - description: >-
      Programación de ventanas de operación del STR que rige cuándo pueden
      enviarse las operaciones.
    name: Schedule
  - description: >-
      Consultas de horarios STR0001 de parte única (consulta de horários do STR)
      y sus resultados de grilla STR0001R1 asíncronos.
    name: ScheduleQueries
  - description: >-
      Ajustes de configuración del SPB en tiempo de ejecución para la
      integración STR.
    name: Settings
  - description: Registro y gestión de endpoints de webhook para la entrega de eventos.
    name: Webhooks
  - description: >-
      Flujo (orden obligatorio): certificado → disponibilidad →
      prueba-de-conectividad → envío. Activa un certificado, confirma que el
      rail reporta listo, pasa una prueba de conectividad y luego envía una
      operación. Cada paso es su propio recurso; no debes intentar un envío
      antes de que la disponibilidad pase.
    name: onboarding
  - description: >-
      Flujo (orden obligatorio): operación padre SETTLED →
      devolución/cancelación. Una devolución o cancelación es un sub-recurso de
      una operación padre liquidada; el segmento de ruta
      {operationId}/{endToEndID} impone el padre estructuralmente.
    name: lifecycle
paths:
  /v1/str/operations/auto-transfer-config:
    post:
      tags:
        - Operations
        - onboarding
      summary: Configurar la transferencia automática de la Conta-PI
      description: >-
        Prerrequisito: el rail debe estar listo antes de un envío: un
        certificado activo (ver rotateCertificate, activateCertificate), un
        reporte de disponibilidad READY (ver getReadiness) y una prueba de
        conectividad aprobada (ver createConnectivityTest). Declara la política
        de transferencia automática del STR por clase de cuenta (la plataforma
        emite el código de red LPI0005): para CADA clase (RB/CL y CCME)
        establece exactamente UNO de {percent, value}; un valor de '0'/'0.00'
        desactiva la transferencia automática para esa clase. 'Gana el último
        mensaje': una nueva configuración reemplaza por completo la anterior.
        Persiste la última trama de configuración enviada y devuelve el código
        de red derivado, el estado de envío y el NUOp. Esto significa que el
        despacho fue aceptado, no una confirmación de BACEN; el STR reconoce de
        forma asíncrona (LPI0005R1) y más tarde reporta cada transferencia
        automática que realiza (LPI0006). Lerian SPB reenvía los valores de
        configuración de forma literal; NO realiza ninguna aritmética.
        Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo
        devuelve la respuesta en caché.
      operationId: createAutoTransferConfig
      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/CreateAutoTransferConfigRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoTransferConfigAcceptedResponse'
          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:
    CreateAutoTransferConfigRequest:
      additionalProperties: false
      properties:
        ccmePercent:
          description: >-
            CCME class: percentage of the CCME balance to auto-transfer. Set
            exactly one of ccmePercent or ccmeValue. '0' disables auto-transfer
            for this class.
          examples:
            - '25'
          type: string
        ccmeValue:
          description: >-
            CCME class: fixed decimal-reais amount to auto-transfer. Set exactly
            one of ccmePercent or ccmeValue. '0.00' disables auto-transfer for
            this class.
          examples:
            - '300.00'
          type: string
        rbClPercent:
          description: >-
            RB/CL class: percentage of the reserve/settlement balance to
            auto-transfer. Set exactly one of rbClPercent or rbClValue. '0'
            disables auto-transfer for this class.
          examples:
            - '50'
          type: string
        rbClValue:
          description: >-
            RB/CL class: fixed decimal-reais amount to auto-transfer. Set
            exactly one of rbClPercent or rbClValue. '0.00' disables
            auto-transfer for this class.
          examples:
            - '1500.25'
          type: string
      type: object
    AutoTransferConfigAcceptedResponse:
      additionalProperties: false
      properties:
        nuOp:
          description: >-
            SFN operation number stamped on the transmitted LPI0005 frame; the
            LPI0005R1 ACK correlates back to it.
          examples:
            - '12345678202606190000005'
          type: string
        status:
          description: >-
            Submit status: dispatch was accepted (the STR ACK arrives
            asynchronously as LPI0005R1).
          examples:
            - SUBMITTED
          type: string
        wireCode:
          description: LPI wire code of the auto-transfer config-set (always LPI0005).
          examples:
            - LPI0005
          type: string
      required:
        - wireCode
        - status
      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

````