> ## 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 IBS repasse operation

> 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 a STR0053 IBS-repasse operation (reserve repasse of IBS settlement values to the comitê gestor) through the operation-centric API. The handler translates the JSON request into the STR0053 XML request path, persists the operation aggregate and SUBMITTED outbound relay work, and returns the canonical OperationAccepted envelope. Dispatch was accepted, not BACEN settlement confirmation. Idempotent — the X-Idempotency key lives with the operation: the same key and 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) answer the stored operation with X-Idempotency-Replayed: true, also after X-TTL has dropped the cached response, and the same key with another request answers 422.



## OpenAPI

````yaml /pt/openapi/v3-current/spb.yaml post /v1/str/operations/ibs-repasses
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/ibs-repasses:
    post:
      tags:
        - Operations
        - onboarding
      summary: Create IBS repasse operation
      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 a STR0053 IBS-repasse operation
        (reserve repasse of IBS settlement values to the comitê gestor) through
        the operation-centric API. The handler translates the JSON request into
        the STR0053 XML request path, persists the operation aggregate and
        SUBMITTED outbound relay work, and returns the canonical
        OperationAccepted envelope. Dispatch was accepted, not BACEN settlement
        confirmation. Idempotent — the X-Idempotency key lives with the
        operation: the same key and 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) answer the
        stored operation with X-Idempotency-Replayed: true, also after X-TTL has
        dropped the cached response, and the same key with another request
        answers 422.
      operationId: createIBSRepasseOperation
      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. The key itself lives with the
            operation.
          in: header
          name: X-TTL
          schema:
            description: >-
              Seconds the cached response is kept; it may only shorten
              IDEMPOTENCY_DEFAULT_TTL_SEC. The key itself lives with the
              operation.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIBSRepasseOperationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationAcceptedResponse'
          description: Created
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  true when the X-Idempotency key already holds an operation:
                  the body is that operation and nothing new was sent to the
                  STR.
                type: string
          links:
            prerequisite:
              description: >-
                Onboarding prerequisite: the rail readiness reported by
                getReadiness must be READY before a submit is accepted.
              operationId: getReadiness
        '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:
    CreateIBSRepasseOperationRequest:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Repasse amount as a decimal string in BRL, minor-unit precision (two
            decimal places). Canonical form only: exactly two decimal places and
            no leading integer zeros — the single spelling the durable column
            stores; anything else is refused at the door with 422.
          examples:
            - '1500.25'
          pattern: ^(0|[1-9][0-9]*)\.[0-9]{2}$
          type: string
        clientReference:
          description: >-
            Optional caller-supplied correlation reference echoed back for
            client-side reconciliation.
          examples:
            - ibs-ref-1
          type: string
        cnpjOrigdrRepFinanc:
          description: >-
            Optional repasse-originator CNPJ (official CNPJ type: exactly 14
            characters, [0-9A-Z]{12}[0-9]{2}). Omitted from the wire when
            absent.
          examples:
            - '12345678000199'
          pattern: ^[0-9A-Z]{12}[0-9]{2}$
          type: string
        description:
          description: Optional free-text description carried with the operation.
          examples:
            - Repasse IBS comite gestor
          type: string
        dtRepFinanc:
          description: >-
            Financial repasse date in BACEN STR0053 ISO date form (e.g.
            2026-06-09). Required and non-blank.
          examples:
            - '2026-06-09'
          minLength: 1
          type: string
        identdRepFinanc:
          description: >-
            Financial-repasse identifier the comitê gestor keys the repasse on
            (required, 1-50 characters). This service mints no value for it: an
            absent or blank identifier is refused with 422.
          examples:
            - REP-2026-0001
          maxLength: 50
          minLength: 1
          type: string
        infSeggc:
          description: >-
            Repeating segregation-informe group ([0..n]); each entry requires
            both an identifier and a timestamp. Absent means the repasse
            references no informe. No item ceiling is imposed: the official XSD
            declares maxOccurs='unbounded' and no BACEN rule caps it.
          items:
            $ref: '#/components/schemas/IBSRepasseInfSeggc'
          type:
            - array
            - 'null'
        metadata:
          additionalProperties: {}
          description: >-
            Opaque client-side metadata forwarded verbatim to the legacy submit
            DTO. NOT persisted on the operation intent or sanitized payload.
          type: object
        qtdTransc:
          description: Optional transaction count (digits only).
          examples:
            - '10'
          type: string
        recipient:
          $ref: '#/components/schemas/OperationParticipantAccount'
          description: >-
            Crediting participant account (comitê gestor) receiving the IBS
            repasse.
        sender:
          $ref: '#/components/schemas/OperationParticipantAccount'
          description: Debiting participant account originating the IBS repasse.
      required:
        - sender
        - recipient
        - amount
        - identdRepFinanc
        - dtRepFinanc
      type: object
    OperationAcceptedResponse:
      additionalProperties: false
      properties:
        acceptedAt:
          description: UTC RFC 3339 timestamp at which the command was accepted.
          examples:
            - '2026-05-06T18:30:00Z'
          format: date-time
          type: string
        capabilityId:
          description: >-
            STR capability identifier resolved for the accepted operation (e.g.
            STR0004).
          examples:
            - STR0004
          type: string
        correlationId:
          description: >-
            Request correlation identifier for tracing the accept across logs
            and traces.
          examples:
            - req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          type: string
        isReplay:
          description: >-
            True when this response replays a prior idempotent accept rather
            than creating a new operation.
          examples:
            - false
          type: boolean
        operationFamily:
          description: >-
            Operation family the accepted command belongs to (e.g.
            bankTransfer).
          enum:
            - bankTransfer
          examples:
            - bankTransfer
          type: string
        operationId:
          description: >-
            Server-assigned operation aggregate UUID used for subsequent status,
            return, and cancellation calls.
          examples:
            - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          format: uuid
          type: string
        protocolMetadata:
          $ref: '#/components/schemas/OperationProtocolMetadata'
          description: >-
            Optional SAFE protocol correlation fields; present once the
            operation is mapped to STR wire identifiers.
        status:
          description: >-
            Current control-plane lifecycle status of the operation; ACCEPTED on
            initial accept.
          enum:
            - ACCEPTED
            - SUBMITTED
            - SENT
            - CONFIRMED
            - REJECTED
            - FAILED
            - PENDING_CONFIGURATION
            - PENDING_RECONCILIATION
            - RETURN_REQUESTED
            - RETURNED
            - CANCEL_REQUESTED
            - CANCELLED
            - RECEIVED
            - DELIVERED
          examples:
            - ACCEPTED
          type: string
      required:
        - operationId
        - operationFamily
        - capabilityId
        - status
        - acceptedAt
        - isReplay
        - correlationId
      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
    IBSRepasseInfSeggc:
      additionalProperties: false
      properties:
        dtHrInfSeggc:
          description: >-
            Segregation-informe timestamp in BACEN STR0053 ISO dateTime form
            (e.g. 2026-06-09T12:00:00) WITHOUT a timezone offset; the wire
            validator enforces the BACEN format.
          examples:
            - '2026-06-09T12:00:00'
          minLength: 1
          type: string
        identdInfSeggc:
          description: >-
            Segregation-informe identifier the repasse references (1-50
            characters).
          examples:
            - SEGGC-INFO-0001
          maxLength: 50
          minLength: 1
          type: string
      required:
        - identdInfSeggc
        - dtHrInfSeggc
      type: object
    OperationParticipantAccount:
      additionalProperties: false
      properties:
        account:
          description: Optional traditional bank account number.
          examples:
            - '123456'
          type: string
        accountType:
          description: >-
            Optional account type, BACEN TpCt: CC (conta corrente), CD (conta de
            depósito), CG (conta garantida), PG (payment account/conta de
            pagamento) or PP (savings/poupança). PG is the only code carried in
            paymentAccount; every other code uses branch + account. CI (conta de
            investimento) is not accepted: BACEN deactivated it in production on
            31/10/2011.
          enum:
            - CC
            - CD
            - CG
            - PG
            - PP
          examples:
            - CC
          type: string
        branch:
          description: Optional bank branch (agência) number.
          examples:
            - '0001'
          type: string
        document:
          description: >-
            Optional holder document (CPF or CNPJ), carried verbatim onto the
            wire.
          examples:
            - '12345678901'
          type: string
        ispb:
          description: Participant ISPB, the 8-character BACEN institution identifier.
          examples:
            - '12345678'
          maxLength: 8
          minLength: 8
          pattern: ^[0-9A-Z]{8}$
          type: string
        name:
          description: >-
            Optional account holder name, at most 80 characters (official type
            Nome).
          examples:
            - João da Silva
          maxLength: 80
          type: string
        party:
          description: >-
            Domain role of this participant: institution (own-account, no client
            identity), client (account-holding client), or nonAccountHolder
            (identified person with no account at the IFs). The transfer's STR
            code is derived from the sender+recipient roles; omitting the key
            defaults to institution, while an explicit empty string is refused.
          enum:
            - institution
            - client
            - nonAccountHolder
          examples:
            - institution
          type: string
        paymentAccount:
          description: >-
            Optional payment account identifier (conta de pagamento). Required
            when accountType is PG.
          examples:
            - '00000000123456'
          type: string
      required:
        - ispb
      type: object
    OperationProtocolMetadata:
      additionalProperties: false
      properties:
        controlNumber:
          description: >-
            Control number identifying the message on the SPB network (official
            ControleIF, 1-20 characters); an issued number is an 8-digit
            movement date + a 12-digit sequence.
          examples:
            - '20260506000000000001'
          maxLength: 20
          minLength: 1
          type: string
        emissionApprovalId:
          description: >-
            Set when the alçada band parked this request: its id in GET
            /v1/str/emission-approvals. Only the accepted answer carries it; GET
            never does.
          type: string
        nuOp:
          description: >-
            STR operation number (NUOp), 23 characters: 8-character alphanumeric
            ISPB + 8-digit date + 7-digit sequence.
          examples:
            - '12345678202605060000001'
          maxLength: 23
          minLength: 23
          pattern: ^[0-9A-Z]{8}[0-9]{15}$
          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.