> ## 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 da operação > Retorna o detalhe sanitizado de uma única operação. Ids desconhecidos aparecem como não encontrado (SPB-0010); o serviço nunca revela a existência de uma operação que não lhe pertence. Os campos de payload de protocolo bruto nunca aparecem nas respostas. ## OpenAPI ````yaml pt/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId} 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/operations/{operationId}: get: tags: - Operations summary: Obter detalhe da operação description: >- Retorna o detalhe sanitizado de uma única operação. Ids desconhecidos aparecem como não encontrado (SPB-0010); o serviço nunca revela a existência de uma operação que não lhe pertence. Os campos de payload de protocolo bruto nunca aparecem nas respostas. operationId: getOperation parameters: - description: Operation UUID. in: path name: operationId required: true schema: description: Operation UUID. format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OperationDetailResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: OperationDetailResponse: additionalProperties: false properties: correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. examples: - req-abc type: string operation: $ref: '#/components/schemas/OperationDetail' description: The requested operation's sanitized detail projection. required: - operation - 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 OperationDetail: additionalProperties: false properties: acceptedAt: description: >- RFC3339 UTC timestamp when the operation was accepted by the control plane; omitted until accepted. examples: - '2026-06-14T12:00:00Z' format: date-time type: string 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 currentStateReason: description: >- Human-readable explanation of the current status (e.g. rejection reason); omitted when the status needs no explanation. type: string direction: description: >- Flow direction relative to this participant: OUTBOUND (sent) or INBOUND (received). examples: - OUTBOUND type: string links: $ref: '#/components/schemas/OperationLinks' description: >- HATEOAS-style links to related resources (timeline, audit records, reconciliation case). 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. resolvedAt: description: >- RFC3339 UTC timestamp when the operation reached a terminal state; omitted while still in flight. examples: - '2026-06-14T12:05:00Z' format: date-time type: string sanitizedPayload: additionalProperties: {} description: >- Sanitized projection of the protocol payload; raw protocol bytes are never included. type: object 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: - links - 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 OperationLinks: additionalProperties: false properties: auditRecords: description: Relative URL of this operation's audit-record collection. examples: - /v1/str/operations/{operationId}/audit-records type: string reconciliationCase: description: >- Relative URL of the associated reconciliation case; omitted when no case exists. examples: - '' type: string timeline: description: Relative URL of this operation's lifecycle timeline. examples: - /v1/str/operations/{operationId}/timeline type: string required: - timeline - auditRecords 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 ````