> ## 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. # Obter detalhe de mensagem STR > Retorna o detalhe do registro de mensagens para uma mensagem STR identificada por seu NUOp: o status e os campos de recibo do BACEN, o payload estruturado, uma visão XML reconstruída na leitura (os bytes on-wire persistidos decodificados para XML, rotulados como reconstruídos; os bytes literais enviados não são retidos separadamente) e a contraparte original<->correspondente resolvida. Busca primeiro as mensagens de saída e depois as de entrada. O NUOp é um identificador BACEN de 23 dígitos: ISPB[8]+DATA[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: >- Interface OpenAPI 3.1 do Lerian SPB, a integração direta entre a instituição e o Sistema de Pagamentos Brasileiro (SPB) sobre a Rede do Sistema Financeiro Nacional (RSFN). Abrange o Sistema de Transferência de Reservas (STR): registro de mensagens e catálogo de capacidades, ciclo de vida das operações (transferências bancárias, repasses IBS, transferências de liquidez, devoluções e cancelamentos), consultas de conta de reservas e de horários, governança de alçada, conciliação e entrega de eventos. license: name: Lerian Studio General License title: Lerian SPB API version: 1.0.0 servers: - url: https://spb.sandbox.lerian.net security: [] tags: - description: >- Trilhas imutáveis de registros de auditoria para operações STR e eventos de ciclo de vida. name: Audit - description: >- Catálogo de capacidades STR que descreve os tipos de mensagem suportados e suas restrições. name: Capabilities - description: >- Inventário de certificados ICP-Brasil com rotação e ativação recarregáveis a quente. name: Certificates - description: >- Fila de aprovação maker-checker para emissões retidas acima de sua banda de alçada: listar pendentes, assinar (aprovar) e negar. name: EmissionApprovals - description: >- Registros de entrega de eventos por webhook com controle de retentativas para despachos falhos. name: EventDeliveries - description: >- Catálogo de eventos de operação que enumera os tipos de evento de domínio emitidos. name: Events - description: >- Registro de avisos recebidos da família GEN (GEN0001 eco de conectividade, GEN0004 erro de transmissão, GEN0005 aviso administrativo). name: GenNotices - description: >- Governança de alçada do SPB: a tabela de bandas de valor e os requisitos de assinatura por tipo de mensagem, recarregados a quente em tempo de execução. name: Governance - description: >- Estado bruto das mensagens STR: listar as mensagens e ler uma mensagem individual por NUOp. name: Messages - description: Resumos e métricas operacionais agregados das operações STR. name: OperationalIntelligence - description: >- Ciclo de vida das operações STR para transferências bancárias e repasses IBS, incluindo devoluções e cancelamentos. name: Operations - description: >- Estado de prontidão do serviço que abrange as autoverificações de inicialização e a saúde das dependências. name: Readiness - description: Casos de conciliação e as ações que resolvem as divergências de operação. name: Reconciliation - description: >- Suíte de relatórios STR: relatórios agregados síncronos por intervalo de datas (movimento financeiro, transações rejeitadas, volumetria) sobre o próprio registro de transmissão do Lerian SPB. name: Reports - description: >- Consultas de saldo de conta de reservas STR0013 e de extrato STR0014 (modo mensagem) e seus resultados assíncronos. name: ReserveQueries - description: >- Lista de responsáveis do participante GEN0019: atualizações de substituição total anunciadas ao BACEN. name: Responsibles - description: >- Programação de janelas de operação do STR que rege quando as operações podem ser enviadas. name: Schedule - description: >- Consultas de horários STR0001 de parte única (consulta de horários do STR) e seus resultados de grade STR0001R1 assíncronos. name: ScheduleQueries - description: Configurações de tempo de execução do SPB para a integração STR. name: Settings - description: >- Registro e gerenciamento de endpoints de webhook para a entrega de eventos. name: Webhooks - description: >- Fluxo (ordem obrigatória): certificado → prontidão → teste-de-conectividade → envio. Ative um certificado, confirme que o rail reporta prontidão, passe em um teste de conectividade e então envie uma operação. Cada etapa é seu próprio recurso; um envio não deve ser tentado antes de a prontidão passar. name: onboarding - description: >- Fluxo (ordem obrigatória): operação pai SETTLED → devolução/cancelamento. Uma devolução ou cancelamento é um sub-recurso de uma operação pai liquidada; o segmento de rota {operationId}/{endToEndID} impõe o pai estruturalmente. name: lifecycle paths: /v1/str/messages/{nuOp}: get: tags: - Messages summary: Obter detalhe de mensagem STR description: >- Retorna o detalhe do registro de mensagens para uma mensagem STR identificada por seu NUOp: o status e os campos de recibo do BACEN, o payload estruturado, uma visão XML reconstruída na leitura (os bytes on-wire persistidos decodificados para XML, rotulados como reconstruídos; os bytes literais enviados não são retidos separadamente) e a contraparte original<->correspondente resolvida. Busca primeiro as mensagens de saída e depois as de entrada. O NUOp é um identificador BACEN de 23 dígitos: ISPB[8]+DATA[8]+SEQ[7]. operationId: getMessageStatus parameters: - description: 'Message NUOp (23 digits: ISPB[8]+DATE[8]+SEQ[7]).' in: path name: nuOp required: true schema: description: 'Message NUOp (23 digits: ISPB[8]+DATE[8]+SEQ[7]).' maxLength: 23 minLength: 23 pattern: ^[0-9]{23}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageDetailResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: MessageDetailResponse: additionalProperties: false properties: 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: >- How the payload is presented: 'reconstructed' when reconstructedXml carries the persisted on-wire bytes decoded to XML, 'structured' when only the payload fields are available. examples: - reconstructed type: string reconstructedXml: description: >- The persisted on-wire STR payload decoded to UTF-8 XML, labeled reconstructed (the literal sent bytes are not separately retained). Omitted when payloadFormat is 'structured'. type: string required: - message - payload - payloadFormat 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 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: STR control number of the correspondent, when assigned. examples: - '20260503000001' 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). 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-9]{8}[0-9]{8}[0-9]{7}$ type: string status: description: Normalized public processing status of the correspondent. 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: >- STR control number, 14 digits identifying the message on the SPB network; omitted until assigned. examples: - '20260503000001' maxLength: 14 minLength: 14 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). 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 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 originalControlNumber: description: >- Control number of the referenced original message for lifecycle (return/cancel) messages, 14 digits. examples: - '20260503000001' maxLength: 14 minLength: 14 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-9]{23}$ 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-digit BACEN institution identifier. examples: - 38166 maxLength: 8 minLength: 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-digit BACEN institution identifier. examples: - '12345678' maxLength: 8 minLength: 8 type: string status: description: Normalized public processing status of the message. 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 securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````