> ## 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 received electronic-money advices

> Returns the durable log of electronic-money movements the STR ADVISED us about over a client's conta correspondente a moeda eletrônica (CCME) — movements this rail did NOT command. Each leg reaches the side that did not command it: SME0001R2 (an FI funded a CCME) reaches the credited IEME, SME0002R2 (funds were recalled out of a CCME) reaches the FI, SME0004R2 (an entry received in error was given back) reaches the credited party. An advice is therefore never an answer to a frame we sent, and correlating it to one is wrong by construction. Amounts and the BACEN date stamps cross VERBATIM as the frame spelled them, with no arithmetic and no parsing; the response carries NO total, so a client learns how many advices it loaded and never how many exist. Most recent first by receipt; optionally filter by advice leg or by the window in which this rail received them.



## OpenAPI

````yaml /en/openapi/v3-current/spb.yaml get /v1/str/sme-advices
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://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 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: >-
      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: >-
      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: 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/sme-advices:
    get:
      tags:
        - SMEQueries
      summary: List received electronic-money advices
      description: >-
        Returns the durable log of electronic-money movements the STR ADVISED us
        about over a client's conta correspondente a moeda eletrônica (CCME) —
        movements this rail did NOT command. Each leg reaches the side that did
        not command it: SME0001R2 (an FI funded a CCME) reaches the credited
        IEME, SME0002R2 (funds were recalled out of a CCME) reaches the FI,
        SME0004R2 (an entry received in error was given back) reaches the
        credited party. An advice is therefore never an answer to a frame we
        sent, and correlating it to one is wrong by construction. Amounts and
        the BACEN date stamps cross VERBATIM as the frame spelled them, with no
        arithmetic and no parsing; the response carries NO total, so a client
        learns how many advices it loaded and never how many exist. Most recent
        first by receipt; optionally filter by advice leg or by the window in
        which this rail received them.
      operationId: listSMEAdvices
      parameters:
        - description: >-
            Optional advice-leg filter. Only the three response legs are
            admitted: the R1 legs are answers to this rail's OWN commands, not
            third-party advice.
          explode: false
          in: query
          name: wireCode
          schema:
            description: >-
              Optional advice-leg filter. Only the three response legs are
              admitted: the R1 legs are answers to this rail's OWN commands, not
              third-party advice.
            enum:
              - SME0001R2
              - SME0002R2
              - SME0004R2
            type: string
        - description: >-
            Optional inclusive start of the window in which THIS RAIL RECEIVED
            the advice (receivedAt) — not the BACEN business date dtMovto.
            RFC3339 instant or bare YYYY-MM-DD.
          explode: false
          in: query
          name: startDate
          schema:
            description: >-
              Optional inclusive start of the window in which THIS RAIL RECEIVED
              the advice (receivedAt) — not the BACEN business date dtMovto.
              RFC3339 instant or bare YYYY-MM-DD.
            examples:
              - '2026-09-01'
            type: string
        - description: >-
            Optional inclusive end of the window in which THIS RAIL RECEIVED the
            advice (receivedAt) — not the BACEN business date dtMovto. A bare
            YYYY-MM-DD spans the whole day.
          explode: false
          in: query
          name: endDate
          schema:
            description: >-
              Optional inclusive end of the window in which THIS RAIL RECEIVED
              the advice (receivedAt) — not the BACEN business date dtMovto. A
              bare YYYY-MM-DD spans the whole day.
            examples:
              - '2026-09-02'
            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 50, max 100).
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            description: Items per page (default 50, max 100).
            format: int64
            maximum: 100
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMEAdvicesResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '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
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    SMEAdvicesResponse:
      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: >-
            Received advices matching the request, most recent first (by the
            receipt clock of this rail).
          items:
            $ref: '#/components/schemas/SMEAdviceItem'
          type:
            - array
            - 'null'
        limit:
          description: Effective page size applied to this response.
          examples:
            - 50
          format: int64
          type: integer
        nextCursor:
          description: >-
            Opaque cursor for the next page; absent when this is the last page.
            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:
            - SPB-0001
          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
    SMEAdviceItem:
      additionalProperties: false
      properties:
        agCredtd:
          description: Credited agency (agência) of a withdrawal advice. SME0002R2 only.
          examples:
            - '0001'
          type: string
        amount:
          description: >-
            VlrLanc as the decimal-reais string BACEN sent, VERBATIM. Never
            parsed, never reformatted, never summed — this feed reports
            movements it did not command and holds no position.
          examples:
            - '1200.55'
          type: string
        cnpjCliCredtd:
          description: CNPJ of the credited client of a withdrawal advice. SME0002R2 only.
          examples:
            - '12345678000199'
          type: string
        creditedIspb:
          description: >-
            ISPB of the credited side, when the leg carries one. Absent on
            SME0002R2, where the credited party is the Reservas Bancárias
            account group instead.
          examples:
            - '12345678'
          pattern: ^[0-9A-Z]{8}$
          type: string
        ctCredtd:
          description: Credited account number of a withdrawal advice. SME0002R2 only.
          examples:
            - '123456'
          type: string
        debitedIspb:
          description: >-
            ISPB of the debited side, when the leg carries one (8 uppercase
            alphanumeric characters).
          examples:
            - '00038166'
          pattern: ^[0-9A-Z]{8}$
          type: string
        description:
          description: >-
            Hist — the return's free-text history. SME0004R2 only, and
            officially optional.
          examples:
            - devolucao de lancamento recebido em duplicidade
          type: string
        dtHrBC:
          description: >-
            BACEN timestamp of the entry, carried VERBATIM as the frame spelled
            it — not a parsed date, and deliberately not declared as date-time.
          examples:
            - '2026-09-02T09:15:00'
          type: string
        dtMovto:
          description: >-
            BACEN business date of the entry, carried VERBATIM — not a parsed
            date. It is a different question from receivedAt, which is when THIS
            rail got the advice.
          examples:
            - '2026-09-02'
          type: string
        id:
          description: Row identifier of the persisted advice.
          examples:
            - 0190b3a1-1c2d-7e4f-8a9b-0c1d2e3f4a5b
          type: string
        ispbIFCredtd:
          description: >-
            ISPB of the credited FI of a withdrawal advice. SME0002R2 only, and
            present only together with the other three account fields.
          examples:
            - '00038166'
          pattern: ^[0-9A-Z]{8}$
          type: string
        numCtrlSTR:
          description: >-
            STR-assigned control number of the movement, and the identity of the
            advice. Present on all three legs.
          examples:
            - '20260902000001'
          type: string
        originalControlNumber:
          description: >-
            NumCtrlSTROr — the control number of the entry a return gives back.
            SME0004R2 only.
          examples:
            - '20260901000009'
          type: string
        receivedAt:
          description: >-
            RFC3339 UTC timestamp this rail projected the advice. The one
            derived value on the item, and the clock the feed is ordered and
            windowed by.
          examples:
            - '2026-09-02T12:00:00Z'
          format: date-time
          type: string
        wireCode:
          description: >-
            Advice leg: SME0001R2 (an FI funded a CCME), SME0002R2 (funds were
            recalled out of a CCME) or SME0004R2 (an entry received in error was
            given back). This is the only statement of what kind of movement
            occurred — the legs carry no debit/credit indicator.
          examples:
            - SME0001R2
          type: string
      required:
        - id
        - wireCode
        - numCtrlSTR
        - amount
        - receivedAt
      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

````