> ## 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 STR messages > Lists outbound and inbound STR messages with optional filters and cursor-based pagination. The cursor is opaque — pass the nextCursor value from a previous response to continue. Filters can be combined freely; results are merged in the requested sort order. ## OpenAPI ````yaml en/openapi/v3-current/spb.yaml get /v1/str/messages 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/messages: get: tags: - Messages summary: List STR messages description: >- Lists outbound and inbound STR messages with optional filters and cursor-based pagination. The cursor is opaque — pass the nextCursor value from a previous response to continue. Filters can be combined freely; results are merged in the requested sort order. operationId: listMessages parameters: - 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: Page size (default 20, max 100). explode: false in: query name: limit schema: default: 20 description: Page size (default 20, max 100). format: int64 maximum: 100 minimum: 1 type: integer - description: Sort order (default desc, most recent first). explode: false in: query name: sort_order schema: description: Sort order (default desc, most recent first). enum: - asc - desc type: string - description: Filter by STR message type (e.g. STR0004). explode: false in: query name: message_type schema: description: Filter by STR message type (e.g. STR0004). type: string - description: Filter by processing status. explode: false in: query name: status schema: description: Filter by processing status. enum: - SUBMITTED - DELIVERED - CONFIRMED - REJECTED - FAILED - RETURNED - CANCELED - RECEIVED type: string - description: Filter by message direction. explode: false in: query name: direction schema: description: Filter by message direction. enum: - inbound - outbound type: string - description: Lower bound for created_at (RFC3339 or YYYY-MM-DD). explode: false in: query name: start_date schema: description: Lower bound for created_at (RFC3339 or YYYY-MM-DD). type: string - description: Upper bound for created_at (RFC3339 or YYYY-MM-DD). explode: false in: query name: end_date schema: description: Upper bound for created_at (RFC3339 or YYYY-MM-DD). type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessagesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ListMessagesResponse: 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: Page of message summaries ordered most-recent-first. items: $ref: '#/components/schemas/MessageSummary' type: - array - 'null' limit: description: Page size applied to this response (number of items requested). examples: - 50 format: int64 type: integer nextCursor: description: >- Opaque cursor for the next page; absent when there are no more results. Presence signals more results, absence signals end-of-list. examples: - >- eyJjcmVhdGVkQXQiOiIyMDI2LTA1LTA0VDE4OjMwOjAwWiIsImlkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0 type: string prevCursor: description: >- Opaque cursor for the previous page; reserved for future bidirectional cursoring, absent today. 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: -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 MessageSummary: additionalProperties: false properties: amount: description: >- Message amount as a decimal string in BRL, minor-unit precision (two decimal places). examples: - '150.00' pattern: ^[0-9]+(\.[0-9]+)?$ type: string controlNumber: description: >- STR control number, 14 digits identifying the message on the SPB network; omitted until assigned (outbound) or absent (inbound). examples: - '20260503000001' type: string createdAt: description: >- UTC RFC 3339 timestamp at which the message record was created — JD's Data/Hora column. examples: - '2026-05-04T18:29:55Z' format: date-time type: string direction: description: >- Message flow direction — JD's Fluxo column: OUTBOUND (Enviada) or INBOUND (Recebida). examples: - OUTBOUND type: string messageType: description: STR message type (e.g. STR0004). examples: - STR0004 type: string mqMessageId: description: >- Broker-assigned message identifier returned by MQPUT — JD's 'ID Recepção BC'. Outbound only. examples: - 414d5120514d2020202020202020202060f0c2a201a30b25 type: string nuOp: description: >- STR operation number (NUOp) of the message, 23 digits: 8-digit ISPB + 8-digit date + 7-digit sequence. examples: - '12345678202605040000001' maxLength: 23 minLength: 23 pattern: ^[0-9]{8}[0-9]{8}[0-9]{7}$ type: string resolvedAt: description: >- UTC RFC 3339 timestamp at which the message reached a terminal status; absent while still in flight. examples: - '2026-05-04T18:30:05Z' format: date-time type: string status: description: >- Normalized public processing status of the message — JD's Situação column. examples: - DELIVERED type: string strStatus: description: >- Raw STR-network status string as returned by BACEN (e.g. Acatado) — JD's StatusCode column. Absent until BACEN responds. examples: - Acatado type: string required: - nuOp - messageType - status - direction - createdAt 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 ````