> ## 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. # Actualizar ajustes de canal > Aplica un patch a los ajustes de canal del STR. Solo se actualizan los campos provistos; los campos ausentes conservan su valor actual. Debe proveerse al menos un campo. Establecer el ISPB del participante requiere un valor explícito de 8 dígitos (se rechazan placeholders como 00000000). Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché. ## OpenAPI ````yaml es/openapi/v3-current/spb.yaml patch /v1/str/settings openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Interfaz OpenAPI 3.1 de Lerian SPB, la integración directa entre la institución y el Sistema de Pagos Brasileño (SPB) sobre la Red del Sistema Financiero Nacional (RSFN). Cubre el Sistema de Transferencia de Reservas (STR): registro de mensajes y catálogo de capacidades, ciclo de vida de las operaciones (transferencias bancarias, repasses IBS, transferencias de liquidez, devoluciones y cancelaciones), consultas de cuenta de reservas y de horarios, gobernanza de alçada, conciliación y 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: >- Rastros inmutables de registros de auditoría para operaciones STR y eventos de ciclo de vida. name: Audit - description: >- Catálogo de capacidades STR que describe los tipos de mensaje admitidos y sus restricciones. name: Capabilities - description: >- Inventario de certificados ICP-Brasil con rotación y activación recargables en caliente. name: Certificates - description: >- Cola de aprobación maker-checker para emisiones retenidas por encima de su banda de alçada: listar pendientes, firmar (aprobar) y denegar. name: EmissionApprovals - description: >- Registros de entrega de eventos por webhook con control de reintentos para despachos fallidos. name: EventDeliveries - description: >- Catálogo de eventos de operación que enumera los tipos de evento de dominio emitidos. name: Events - description: >- Registro de avisos entrantes de la familia GEN (GEN0001 eco de conectividad, GEN0004 error de transmisión, GEN0005 aviso administrativo). name: GenNotices - description: >- Gobernanza de alçada del SPB: la tabla de bandas de valor y los requisitos de firma por tipo de mensaje, recargados en caliente en tiempo de ejecución. name: Governance - description: >- Estado crudo de los mensajes STR: listar los mensajes y leer un mensaje individual por NUOp. name: Messages - description: Resúmenes y métricas operativas agregadas de las operaciones STR. name: OperationalIntelligence - description: >- Ciclo de vida de las operaciones STR para transferencias bancarias y repasses IBS, incluyendo devoluciones y cancelaciones. name: Operations - description: >- Estado de disponibilidad del servicio que abarca las autopruebas de arranque y la salud de las dependencias. name: Readiness - description: >- Casos de conciliación y las acciones que resuelven las discrepancias de operación. name: Reconciliation - description: >- Suite de reportes STR: reportes agregados síncronos por rango de fechas (movimiento financiero, transacciones rechazadas, volumetria) sobre el propio registro de transmisión de Lerian SPB. name: Reports - description: >- Consultas de saldo de cuenta de reservas STR0013 y de extrato STR0014 (modo mensaje) y sus resultados asíncronos. name: ReserveQueries - description: >- Lista de responsáveis del participante GEN0019: actualizaciones de reemplazo total anunciadas a BACEN. name: Responsibles - description: >- Programación de ventanas de operación del STR que rige cuándo pueden enviarse las operaciones. name: Schedule - description: >- Consultas de horarios STR0001 de parte única (consulta de horários do STR) y sus resultados de grilla STR0001R1 asíncronos. name: ScheduleQueries - description: >- Ajustes de configuración del SPB en tiempo de ejecución para la integración STR. name: Settings - description: Registro y gestión de endpoints de webhook para la entrega de eventos. name: Webhooks - description: >- Flujo (orden obligatorio): certificado → disponibilidad → prueba-de-conectividad → envío. Activa un certificado, confirma que el rail reporta listo, pasa una prueba de conectividad y luego envía una operación. Cada paso es su propio recurso; no debes intentar un envío antes de que la disponibilidad pase. name: onboarding - description: >- Flujo (orden obligatorio): operación padre SETTLED → devolución/cancelación. Una devolución o cancelación es un sub-recurso de una operación padre liquidada; el segmento de ruta {operationId}/{endToEndID} impone el padre estructuralmente. name: lifecycle paths: /v1/str/settings: patch: tags: - Settings summary: Actualizar ajustes de canal description: >- Aplica un patch a los ajustes de canal del STR. Solo se actualizan los campos provistos; los campos ausentes conservan su valor actual. Debe proveerse al menos un campo. Establecer el ISPB del participante requiere un valor explícito de 8 dígitos (se rechazan placeholders como 00000000). Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché. operationId: updateSettings parameters: - description: Idempotency key (primary). in: header name: X-Idempotency schema: description: Idempotency key (primary). type: string - description: Idempotency key (legacy alias for X-Idempotency). in: header name: X-Idempotency-Key schema: description: Idempotency key (legacy alias for X-Idempotency). type: string - description: Idempotency key TTL in seconds (overrides the configured default). in: header name: X-TTL schema: description: Idempotency key TTL in seconds (overrides the configured default). type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSettingsInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SettingsResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: UpdateSettingsInput: additionalProperties: false properties: deliveryMode: description: >- Optional notification delivery mode to set: WEBHOOK, EVENT (streaming), or BOTH; left unchanged when omitted. examples: - WEBHOOK type: string ispb: description: >- Optional participant ISPB to set, the 8-digit BACEN institution identifier; left unchanged when omitted. examples: - '12345678' maxLength: 8 minLength: 8 pattern: ^[0-9]{8}$ type: string metadata: additionalProperties: {} description: >- Optional client-supplied settings metadata to merge; sensitive keys are redacted on read. type: object type: object SettingsResponse: additionalProperties: false properties: certDaysRemaining: description: >- Whole days remaining until the active certificate expires; absent when no certificate is configured. examples: - 365 format: int64 type: integer certificateExpiresAt: description: >- UTC RFC 3339 expiry timestamp of the active ICP-Brasil certificate; absent when no certificate is configured. examples: - '2027-05-04T18:30:00Z' format: date-time type: string channelStatus: description: 'SPB channel connectivity status: CONNECTED or PENDING_CONFIGURATION.' examples: - CONNECTED type: string deliveryMode: description: 'Notification delivery mode: WEBHOOK, EVENT (streaming), or BOTH.' examples: - WEBHOOK type: string ispb: description: >- Participant ISPB the settings belong to, the 8-digit BACEN institution identifier. examples: - '12345678' maxLength: 8 minLength: 8 pattern: ^[0-9]{8}$ type: string metadata: additionalProperties: {} description: >- Client-supplied settings metadata; sensitive keys and values are redacted before being returned. type: object readiness: $ref: '#/components/schemas/ReadinessSummary' description: >- Embedded readiness summary; present only when the readiness summary is available. webhooks: description: Configured webhook endpoints that receive STR notifications. items: $ref: '#/components/schemas/WebhookEndpointResponse' type: - array - 'null' required: - ispb - deliveryMode - channelStatus - webhooks 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 ReadinessSummary: additionalProperties: false properties: blockers: description: >- Messages for conditions that block readiness; empty when there are none. examples: - - 'redis: connection refused' items: type: string type: - array - 'null' status: description: Aggregate readiness status. examples: - READY type: string warnings: description: >- Messages for non-blocking conditions that need attention; empty when there are none. examples: - - certificate expires in 12 days items: type: string type: - array - 'null' required: - status - blockers - warnings type: object WebhookEndpointResponse: additionalProperties: false properties: createdAt: description: UTC RFC 3339 timestamp at which the webhook endpoint was created. examples: - '2026-05-04T18:30:00Z' format: date-time type: string id: description: Server-assigned webhook endpoint UUID. examples: - 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string isActive: description: Whether the endpoint is currently active and receiving deliveries. examples: - true type: boolean messageTypes: description: >- STR message types this endpoint subscribes to; empty means all types. examples: - - STR0004 - STR0007 items: type: string type: - array - 'null' metadata: additionalProperties: {} description: Client-supplied metadata for the webhook endpoint. type: object url: description: >- HTTPS URL that receives webhook deliveries for the subscribed message types. examples: - https://example.com/webhooks/str type: string required: - id - url - messageTypes - isActive - 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 ````