> ## 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. # List STR capabilities > Returns the public catalog of STR capabilities. Every authenticated caller sees the same rows. Supports filtering by operation family, handling mode, direction, and availability. Cursor-based pagination. ## OpenAPI ````yaml /pt/openapi/v3-current/spb.yaml get /v1/str/capabilities 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/capabilities: get: tags: - Capabilities summary: List STR capabilities description: >- Returns the public catalog of STR capabilities. Every authenticated caller sees the same rows. Supports filtering by operation family, handling mode, direction, and availability. Cursor-based pagination. operationId: listCapabilities parameters: - description: Exact-match operation family filter (e.g. bankTransfer). explode: false in: query name: operationFamily schema: description: Exact-match operation family filter (e.g. bankTransfer). type: string - description: Canonical HandlingMode filter. explode: false in: query name: handlingMode schema: description: Canonical HandlingMode filter. enum: - PUBLICLY_SUBMITTABLE - RECEIVE_ONLY - LIFECYCLE_RESPONSE - DIAGNOSTIC_ONLY - NOT_APPLICABLE - NOT_READY type: string - description: Direction filter. explode: false in: query name: direction schema: description: Direction filter. enum: - INBOUND - OUTBOUND - BIDIRECTIONAL type: string - description: Filter by availability flag. Absent means no filter. explode: false in: query name: isAvailable schema: description: Filter by availability flag. Absent means no filter. enum: - 'true' - 'false' type: string - description: Opaque pagination token from a previous response. explode: false in: query name: cursor schema: description: Opaque pagination token from a previous response. type: string - description: Items per page. explode: false in: query name: limit schema: default: 50 description: Items per page. format: int64 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/CapabilityListResponse' 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 '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: CapabilityListResponse: additionalProperties: false properties: correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. examples: - req-7a3f9c2e type: string items: description: Capabilities on this page. items: $ref: '#/components/schemas/CapabilityResponse' type: array limit: description: Page size applied to this response (max items returned). examples: - 50 format: int64 type: integer nextCursor: description: >- Opaque cursor for the next page; absent when there are no further pages. type: string required: - items - limit - 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 CapabilityResponse: additionalProperties: false properties: capabilityId: description: >- Public capability identifier: the rail's message code (STR0004 on SPB, the ISO 20022 message type pacs.008 on SPI). type: string direction: description: >- Message flow direction: INBOUND (received), OUTBOUND (submitted), or BIDIRECTIONAL. enum: - INBOUND - OUTBOUND - BIDIRECTIONAL examples: - OUTBOUND type: string disposition: description: >- Coverage disposition for this capability: full — a client transacts or queries this code end to end; notice — a routed inbound notice handled with domain semantics and an emitted event, rather than bare routing; deferred — an explicit deferral; not-addressed — the message exists in the protocol but is addressed to NEITHER leg of this participant, so this deployment can never send or receive it. isAvailable is the coarser boolean and answers a different question: whether the capability can be exercised right now. This answers what coverage is claimed for it. enum: - full - notice - deferred - not-addressed examples: - full type: string handlingMode: description: >- How the capability may be exercised: PUBLICLY_SUBMITTABLE (caller-initiated), RECEIVE_ONLY (inbound only), LIFECYCLE_RESPONSE (protocol-driven reply), DIAGNOSTIC_ONLY, NOT_APPLICABLE, or NOT_READY. enum: - PUBLICLY_SUBMITTABLE - RECEIVE_ONLY - LIFECYCLE_RESPONSE - DIAGNOSTIC_ONLY - NOT_APPLICABLE - NOT_READY examples: - PUBLICLY_SUBMITTABLE type: string isAvailable: description: Whether the capability is currently available for use. examples: - true type: boolean name: description: Human-readable capability name. type: string operationFamily: description: >- Operation family the capability belongs to (bankTransfer on SPB, the ISO 20022 family PACS on SPI). type: string protocolMetadata: additionalProperties: {} description: >- Optional capability-specific protocol metadata (safe codes and feature flags only). type: object supportsAudit: description: Whether the capability records audit evidence. examples: - true type: boolean supportsEvents: description: >- Whether the capability emits lifecycle events on the event-delivery surface. examples: - true type: boolean supportsInbound: description: Whether the capability processes inbound messages from BACEN. examples: - false type: boolean supportsSubmission: description: Whether the capability accepts caller-initiated submissions. examples: - true type: boolean required: - capabilityId - name - operationFamily - direction - handlingMode - isAvailable - disposition - supportsSubmission - supportsInbound - supportsEvents - supportsAudit 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.