> ## 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. # Create reconciliation action > Records an operator recovery action on a reconciliation case. Valid actions are ACKNOWLEDGE, RESOLVE, DISMISS, INVESTIGATE. Terminal cases (RESOLVED / DISMISSED) reject further actions with SPB-3007 / HTTP 409. ## OpenAPI ````yaml /pt/openapi/v3-current/spb.yaml post /v1/str/reconciliations/{reconciliationId}/actions 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/reconciliations/{reconciliationId}/actions: post: tags: - Reconciliation summary: Create reconciliation action description: >- Records an operator recovery action on a reconciliation case. Valid actions are ACKNOWLEDGE, RESOLVE, DISMISS, INVESTIGATE. Terminal cases (RESOLVED / DISMISSED) reject further actions with SPB-3007 / HTTP 409. operationId: createReconciliationAction parameters: - description: Reconciliation case UUID. in: path name: reconciliationId required: true schema: description: Reconciliation case UUID. type: string - description: Idempotency key. Required on every mutation. in: header name: X-Idempotency required: true schema: description: Idempotency key. Required on every mutation. type: string - description: >- Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC. in: header name: X-TTL schema: description: >- Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReconciliationActionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReconciliationActionResponse' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '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 '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '413': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Request Entity Too Large '415': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unsupported Media Type '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 '504': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Gateway Timeout default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: CreateReconciliationActionRequest: additionalProperties: false properties: action: description: >- Recovery action to record: ACKNOWLEDGE, RESOLVE, DISMISS, or INVESTIGATE. enum: - ACKNOWLEDGE - RESOLVE - DISMISS - INVESTIGATE examples: - ACKNOWLEDGE type: string metadata: additionalProperties: {} description: >- Optional sanitized JSON object with additional action context (no PII). type: object reason: description: >- Operator-supplied human-readable rationale for the action. The 512-character bound is LERIAN'S OWN, not BACEN's: a recovery-action rationale is Lerian SPB audit evidence and never crosses an SFN wire. The case service enforces the same bound as defence in depth. examples: - investigating with bank maxLength: 512 minLength: 1 type: string required: - action - reason type: object ReconciliationActionResponse: additionalProperties: false properties: actionId: description: UUID of the newly recorded reconciliation action. examples: - b4e8f1a2-6c3d-4f57-9a10-1e1234567893 type: string auditId: description: >- UUID of the audit record linked to the action; empty only when audit is not wired. The action and its audit record commit together. examples: - c5f9a2b3-7d4e-4068-ab21-1e1234567894 type: string case: $ref: '#/components/schemas/ReconciliationCaseResponse' description: The reconciliation case after the action transition was applied. correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. type: string status: description: >- Resulting case status after the action: OPEN, IN_PROGRESS, RESOLVED, or DISMISSED. examples: - IN_PROGRESS type: string required: - case - actionId - status - auditId - 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 ReconciliationCaseResponse: additionalProperties: false properties: createdAt: description: RFC3339 UTC row insertion timestamp. examples: - '2026-06-14T12:00:00Z' type: string nuOp: description: >- BACEN protocol identifier (NUOp) of the send the case concerns; null when the case names an operation, or a BACEN notice that names no send of this rail. examples: - '12345678202606140000001' pattern: ^[0-9A-Z]{8}[0-9]{15}$ type: string openedAt: description: RFC3339 UTC timestamp when the case was first detected. examples: - '2026-06-14T12:00:00Z' type: string operationFamily: description: >- Family the case is filed under, for filter reads: the message-catalogue family (str_capability) of the send its nuOp names, else of its protocolMessageType; bankTransfer when the catalogue lists neither. examples: - bankTransfer type: string operationId: description: >- UUID of the str_operation this case is bound to; omitted for protocol-only anomalies discovered before an operation bridge exists. examples: - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890 type: string protocolControlNumber: description: >- Control number the anomaly's message carries (1-20 characters): its NumCtrlIF or NumCtrlSTR, or the NumCtrlSLBOr or NumCtrlRDCOr a BACEN notice quotes; null when not applicable. examples: - '20260614000000000001' maxLength: 20 minLength: 1 type: string protocolMessageType: description: STR message code involved in the anomaly; null when not applicable. examples: - STR0004 type: string reasonCode: description: >- Candidate reason the case was opened (operator-facing string, not a fixed enum). type: string recommendedAction: description: >- Optional suggested next step (e.g. INVESTIGATE, DISMISS, RESUBMIT); a hint, not a contract; null when absent. examples: - INVESTIGATE type: string reconciliationId: description: Reconciliation case row UUID. examples: - 9a2b7c1d-3e4f-4a90-8b21-1e1234567892 type: string resolvedAt: description: >- RFC3339 UTC timestamp when the case transitioned to RESOLVED or DISMISSED; null while still open/in-progress. examples: - '2026-06-14T12:30:00Z' type: string status: description: 'Case lifecycle state: OPEN, IN_PROGRESS, RESOLVED, or DISMISSED.' examples: - OPEN type: string summary: description: >- Short safe operator-facing description of the case (no raw protocol payloads or PII). type: string updatedAt: description: >- RFC3339 UTC timestamp of the last mutation; updated on every state transition. examples: - '2026-06-14T12:30:00Z' type: string required: - reconciliationId - operationFamily - status - reasonCode - summary - openedAt - 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 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.