> ## 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. # Get STR message detail > Returns the message-log detail for an STR message identified by its NUOp: the status and BACEN-receipt fields, the structured payload, and the resolved original<->correspondent counterpart. The signed on-wire frame is NOT returned here — it is read at GET /v1/str/messages/{nuOp}/frame, guarded by its own scope; this body only labels whether one was retained (payloadFormat). Searches outbound messages first, then inbound ones by their own NUOp, then by the BACEN NUOp they arrived with (the nuOp str.operation.received carries). The NUOp is a 23-character BACEN identifier: ISPB[8]+DATE[8]+SEQ[7]. ## OpenAPI ````yaml /pt/openapi/v3-current/spb.yaml get /v1/str/messages/{nuOp} 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/messages/{nuOp}: get: tags: - Messages summary: Get STR message detail description: >- Returns the message-log detail for an STR message identified by its NUOp: the status and BACEN-receipt fields, the structured payload, and the resolved original<->correspondent counterpart. The signed on-wire frame is NOT returned here — it is read at GET /v1/str/messages/{nuOp}/frame, guarded by its own scope; this body only labels whether one was retained (payloadFormat). Searches outbound messages first, then inbound ones by their own NUOp, then by the BACEN NUOp they arrived with (the nuOp str.operation.received carries). The NUOp is a 23-character BACEN identifier: ISPB[8]+DATE[8]+SEQ[7]. operationId: getMessageStatus parameters: - description: 'Message NUOp (23 characters: ISPB[8]+DATE[8]+SEQ[7]).' in: path name: nuOp required: true schema: description: 'Message NUOp (23 characters: ISPB[8]+DATE[8]+SEQ[7]).' maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageDetailResponse' 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 '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '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: MessageDetailResponse: additionalProperties: false properties: correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. examples: - req-7a3f9c2e type: string correspondent: $ref: '#/components/schemas/MessageCorrespondent' description: >- The resolved original<->correspondent counterpart: for an outbound, the inbound response BACEN sent back; for an inbound, the outbound it answers. Absent when no counterpart has been correlated yet. message: $ref: '#/components/schemas/MessageStatusResponse' description: >- The message's status projection (identifiers, lifecycle, BACEN-receipt fields). payload: additionalProperties: {} description: >- The structured payload_json persisted for this message (parsed STR fields). Always present. type: object payloadFormat: description: >- Availability label for the signed on-wire frame: 'reconstructed' means a frame was retained for this message and is readable at GET /v1/str/messages/{nuOp}/frame (guarded by its own scope), 'structured' means no on-wire bytes were retained and only the payload fields above exist. enum: - reconstructed - structured examples: - reconstructed type: string required: - message - payload - payloadFormat - correlationId type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -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 MessageCorrespondent: additionalProperties: false properties: amount: description: Correspondent amount as a decimal string in BRL. examples: - '150.00' pattern: ^[0-9]+(\.[0-9]+)?$ type: string controlNumber: description: >- Control number of the correspondent, when assigned (official ControleIF, 1-20 characters). examples: - '20260503000000000001' maxLength: 20 minLength: 1 type: string createdAt: description: >- UTC RFC 3339 timestamp at which the correspondent record was created. examples: - '2026-05-04T18:30:02Z' format: date-time type: string direction: description: >- Flow direction of the correspondent (always the opposite of the primary message). enum: - INBOUND - OUTBOUND examples: - INBOUND type: string messageType: description: STR message type/code of the correspondent. examples: - STR0004R2 type: string nuOp: description: NUOp of the correspondent message. examples: - '12345678202605040000001' maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string status: description: >- Normalized public processing status of the correspondent. PENDING_APPROVAL is the maker-checker parked state: the emission awaits its distinct-actor signatures before it may liquidate. enum: - SUBMITTED - DELIVERED - CONFIRMED - REJECTED - FAILED - RETURNED - CANCELED - RECEIVED - PENDING_APPROVAL examples: - RECEIVED type: string strStatus: description: Raw STR-network status of the correspondent. examples: - Acatado type: string required: - nuOp - messageType - status - direction - createdAt type: object MessageStatusResponse: 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 confirmedAt: description: >- UTC RFC 3339 timestamp at which BACEN confirmed (R1 Acatado) the message — JD's 'Confirmação BC'. Present only for a CONFIRMED outbound. examples: - '2026-05-04T18:30:05Z' format: date-time type: string controlNumber: description: >- Control number identifying the message on the SPB network (official ControleIF, 1-20 characters). An outbound row carries the number this participant issued: 8-digit movement date + 12-digit sequence. An inbound row carries the number echoed by the counterparty, whose length is only bounded by the official type. Omitted until assigned. examples: - '20260503000000000001' maxLength: 20 minLength: 1 type: string createdAt: description: UTC RFC 3339 timestamp at which the message record was created. examples: - '2026-05-04T18:29:55Z' format: date-time type: string description: description: Optional free-text description carried with the message. examples: - Wire transfer for invoice 2026-Q2-A47 type: string direction: description: >- Message flow direction: OUTBOUND (sent by this participant) or INBOUND (received). enum: - INBOUND - OUTBOUND 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' on the receipt view. Outbound only. examples: - 414d5120514d2020202020202020202060f0c2a201a30b25 type: string nuOp: description: >- STR operation number (NUOp) of the message, 23 characters: 8-character alphanumeric ISPB + 8-digit date + 7-digit sequence. examples: - '12345678202605040000001' maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string originalControlNumber: description: >- Control number of the referenced original message for lifecycle (return/cancel) messages: 1-20 characters (official ControleIF). Quoted from the original message, not issued here, so the whole official range is accepted. examples: - '20260503000000000042' maxLength: 20 minLength: 1 type: string originalNuOp: description: >- For an inbound response, the NUOp of the original outbound message it answers — the correspondent linkage key. examples: - '12345678202605040000001' maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string purposeCode: description: BACEN STR purpose code (finalidade), exactly 5 digits. examples: - '00001' pattern: ^[0-9]{5}$ type: string recipientIspb: description: >- Recipient participant ISPB, the 8-character BACEN institution identifier. examples: - '00038166' maxLength: 8 minLength: 8 pattern: ^[0-9A-Z]{8}$ 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 senderIspb: description: >- Sender participant ISPB, the 8-character BACEN institution identifier. examples: - '12345678' maxLength: 8 minLength: 8 pattern: ^[0-9A-Z]{8}$ type: string status: description: >- Normalized public processing status of the message. PENDING_APPROVAL is the maker-checker parked state: the emission landed above its alçada band and awaits its distinct-actor signatures before it may liquidate; it precedes SUBMITTED and appears on the default unfiltered log. enum: - SUBMITTED - DELIVERED - CONFIRMED - REJECTED - FAILED - RETURNED - CANCELED - RECEIVED - PENDING_APPROVAL examples: - DELIVERED type: string strRejectReason: description: >- BACEN STR rejection reason code when the message was rejected (e.g. AB03). examples: - AB03 type: string strStatus: description: >- Raw STR-network status string as returned by BACEN (e.g. Acatado) — JD's StatusCode column. examples: - Acatado type: string submittedAt: description: >- UTC RFC 3339 timestamp at which the message was submitted; empty until submission. examples: - '2026-05-04T18:30:00Z' format: date-time type: string required: - nuOp - messageType - 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 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.