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

# List operations

> Lists operations with optional filters. Cursor-based pagination — pass the nextCursor from a previous response to continue. The cursor is opaque and MUST NOT be parsed by clients. Raw protocol payload fields never appear in responses.



## OpenAPI

````yaml en/openapi/v3-current/spb.yaml get /v1/str/operations
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:
    get:
      tags:
        - Operations
      summary: List operations
      description: >-
        Lists operations with optional filters. Cursor-based pagination — pass
        the nextCursor from a previous response to continue. The cursor is
        opaque and MUST NOT be parsed by clients. Raw protocol payload fields
        never appear in responses.
      operationId: listOperations
      parameters:
        - description: Operation family filter (e.g. bankTransfer).
          explode: false
          in: query
          name: operationFamily
          schema:
            description: Operation family filter (e.g. bankTransfer).
            type: string
        - description: Capability filter (e.g. STR0004).
          explode: false
          in: query
          name: capabilityId
          schema:
            description: Capability filter (e.g. STR0004).
            type: string
        - description: Public lifecycle status filter.
          explode: false
          in: query
          name: status
          schema:
            description: Public lifecycle status filter.
            type: string
        - description: Direction filter (INBOUND or OUTBOUND).
          explode: false
          in: query
          name: direction
          schema:
            description: Direction filter (INBOUND or OUTBOUND).
            type: string
        - description: Inclusive lower bound (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: startDate
          schema:
            description: Inclusive lower bound (RFC3339 timestamp or YYYY-MM-DD).
            type: string
        - description: Inclusive upper bound (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: endDate
          schema:
            description: Inclusive upper bound (RFC3339 timestamp or YYYY-MM-DD).
            type: string
        - description: Filter by request correlation identity.
          explode: false
          in: query
          name: correlationId
          schema:
            description: Filter by request correlation identity.
            type: string
        - description: Filter by STR protocol nuOp.
          explode: false
          in: query
          name: nuOp
          schema:
            description: Filter by STR protocol nuOp.
            type: string
        - description: Opaque pagination token from a previous response.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque pagination token from a previous response.
            type: string
        - description: Items per page (default 20, max 100).
          explode: false
          in: query
          name: limit
          schema:
            default: 20
            description: Items per page (default 20, max 100).
            format: int64
            maximum: 100
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    OperationListResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          examples:
            - req-7a3f9c2e
          type: string
        items:
          description: Operation summaries for the current page.
          items:
            $ref: '#/components/schemas/OperationSummary'
          type:
            - array
            - 'null'
        limit:
          description: Effective page size applied to this response.
          examples:
            - 20
          format: int64
          type: integer
        nextCursor:
          description: >-
            Opaque cursor for the next page; absent when this is the last page.
            Do not parse.
          type: string
        prevCursor:
          description: >-
            Opaque cursor for the previous page; reserved for future
            bidirectional cursoring. Do not parse.
          type: string
      required:
        - items
        - limit
        - correlationId
      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
    OperationSummary:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Transaction amount as a decimal string in BRL, scale 2; omitted when
            not applicable.
          examples:
            - '150.00'
          type: string
        capabilityId:
          description: >-
            STR capability identifier that produced the operation (e.g.
            STR0004).
          examples:
            - STR0004
          type: string
        clientReference:
          description: >-
            Client-supplied reference echoed back for reconciliation; omitted
            when none was provided.
          examples:
            - client-ref-1
          type: string
        counterpartyISPB:
          description: >-
            The 8-digit ISPB of the counterparty relative to this participant —
            the creditor/recipient for OUTBOUND, the debtor/sender for INBOUND.
            A verbatim copy of the received party identifier; omitted when the
            operation has no counterparty.
          examples:
            - '87654321'
          type: string
        createdAt:
          description: RFC3339 UTC timestamp when the operation was first recorded.
          examples:
            - '2026-05-06T18:30:00Z'
          format: date-time
          type: string
        direction:
          description: >-
            Flow direction relative to this participant: OUTBOUND (sent) or
            INBOUND (received).
          examples:
            - OUTBOUND
          type: string
        operationFamily:
          description: Operation family the operation belongs to (e.g. bankTransfer).
          examples:
            - bankTransfer
          type: string
        operationId:
          description: Operation aggregate UUID, stable across the operation lifecycle.
          examples:
            - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          format: uuid
          type: string
        protocolMetadata:
          $ref: '#/components/schemas/OperationProtocolMetadata'
          description: >-
            Curated, safe STR protocol identifiers (nuOp, controlNumber);
            omitted when none are present.
        scheduledExecutionAt:
          description: >-
            RFC3339 future settlement instant for a scheduled (agendada) STR
            transfer; a verbatim copy of the client-supplied schedule timestamp
            (no computation). Omitted for an immediate, non-scheduled operation.
          examples:
            - '2026-06-23T10:00:00Z'
          format: date-time
          type: string
        status:
          description: Public lifecycle status of the operation.
          examples:
            - ACCEPTED
          type: string
        updatedAt:
          description: RFC3339 UTC timestamp of the last lifecycle update.
          examples:
            - '2026-05-06T18:31:00Z'
          format: date-time
          type: string
      required:
        - operationId
        - operationFamily
        - capabilityId
        - status
        - direction
        - createdAt
        - updatedAt
      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
    OperationProtocolMetadata:
      additionalProperties: false
      properties:
        controlNumber:
          description: >-
            STR control number, 14 digits identifying the message on the SPB
            network.
          examples:
            - '20260506000001'
          maxLength: 14
          minLength: 14
          type: string
        nuOp:
          description: >-
            STR operation number (NUOp), 23 digits: 8-digit ISPB + 8-digit date
            + 7-digit sequence.
          examples:
            - '12345678202605060000001'
          maxLength: 23
          minLength: 23
          pattern: ^[0-9]{8}[0-9]{8}[0-9]{7}$
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````