> ## 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 operation detail > Returns the sanitized detail of a single operation. Unknown ids surface as not-found (SPB-0010); the service never leaks the existence of an operation it does not own. Raw protocol payload fields never appear in responses. ## 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: >- 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/operations/{operationId}: get: tags: - Operations summary: Get operation detail description: >- Returns the sanitized detail of a single operation. Unknown ids surface as not-found (SPB-0010); the service never leaks the existence of an operation it does not own. Raw protocol payload fields never appear in responses. 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 '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: 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). 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 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-character 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' pattern: ^[0-9A-Z]{8}$ 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). enum: - INBOUND - OUTBOUND 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 returnOperationId: description: >- On a received TED credit, the return operation (STR0010) that stands against it: while it stands the credit cannot be returned again. Omitted when there is none, including after the STR refused the return. examples: - 0193f2a0-0000-7000-8000-000000000010 format: uuid 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. enum: - ACCEPTED - SUBMITTED - SENT - CONFIRMED - REJECTED - FAILED - PENDING_CONFIGURATION - PENDING_RECONCILIATION - RETURN_REQUESTED - RETURNED - CANCEL_REQUESTED - CANCELLED - RECEIVED - DELIVERED 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 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 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: >- Control number identifying the message on the SPB network (official ControleIF, 1-20 characters); an issued number is an 8-digit movement date + a 12-digit sequence. examples: - '20260506000000000001' maxLength: 20 minLength: 1 type: string emissionApprovalId: description: >- Set when the alçada band parked this request: its id in GET /v1/str/emission-approvals. Only the accepted answer carries it; GET never does. type: string nuOp: description: >- STR operation number (NUOp), 23 characters: 8-character alphanumeric ISPB + 8-digit date + 7-digit sequence. examples: - '12345678202605060000001' maxLength: 23 minLength: 23 pattern: ^[0-9A-Z]{8}[0-9]{15}$ 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.