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

# Set Conta-PI auto-transfer configuration

> 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). Declares the STR's automatic-transfer policy per account class (the platform emits wire code LPI0005): for EACH class (RB/CL and CCME) set exactly ONE of {percent, value} — a value of '0'/'0.00' disables auto-transfer for that class. 'Last message wins': a new config fully replaces the prior one. Persists the last-sent config frame and returns the derived wire code, the submit status, and the NUOp. This means dispatch was accepted, not BACEN confirmation; the STR acknowledges asynchronously (LPI0005R1) and later reports each automatic transfer it performs (LPI0006). Lerian SPB forwards the config values verbatim; it performs NO arithmetic. 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/auto-transfer-config
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/auto-transfer-config:
    post:
      tags:
        - Operations
        - onboarding
      summary: Set Conta-PI auto-transfer configuration
      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). Declares the STR's automatic-transfer
        policy per account class (the platform emits wire code LPI0005): for
        EACH class (RB/CL and CCME) set exactly ONE of {percent, value} — a
        value of '0'/'0.00' disables auto-transfer for that class. 'Last message
        wins': a new config fully replaces the prior one. Persists the last-sent
        config frame and returns the derived wire code, the submit status, and
        the NUOp. This means dispatch was accepted, not BACEN confirmation; the
        STR acknowledges asynchronously (LPI0005R1) and later reports each
        automatic transfer it performs (LPI0006). Lerian SPB forwards the config
        values verbatim; it performs NO arithmetic. Idempotent — replaying the
        same X-Idempotency key with the same body returns the cached response.
      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

````