> ## 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.

# SPB in Cabine

> The Lerian SPB workspace in Lerian Cabine.

The Lerian Cabine workspace for Lerian SPB shows as **STR**. Operators use it to follow STR operations and messages, move reserve liquidity, sign emissions, find evidence and configure the channel.

## Overview

***

The **Visão geral** screen reads [`GET /v1/str/operational-summary`](https://docs.lerian.studio/en/reference/rails/spb/get-operational-summary). It shows the open reconciliation cases (**Backlog de conciliação**) and the certificates in warning (**Certificados em alerta**). It also shows the volume of operations by family (**Volume por família**) and the liquidity instrument. **Abrir operações** opens the operations list.

## Liquidity

***

The **Liquidez** screen shows the liquidity of the day: **Curva do dia**, **Indicadores BCBS 248** and **Obrigações com horário**. It reads [`GET /v1/str/operations`](https://docs.lerian.studio/en/reference/rails/spb/list-operations) and [`GET /v1/str/schedule`](https://docs.lerian.studio/en/reference/rails/spb/get-schedule). It reads the reserve balance with [`POST /v1/str/reserve-balance-queries`](https://docs.lerian.studio/en/reference/rails/spb/create-reserve-balance-query) and [`GET /v1/str/reserve-balance-queries/{id}`](https://docs.lerian.studio/en/reference/rails/spb/get-reserve-balance-query).

The liquidity instrument also shows on **Visão geral**. It offers an aporte when it recommends one, and a resgate when the Conta PI balance covers its floor. Each action calls [`POST /v1/str/operations/liquidity-transfers`](https://docs.lerian.studio/en/reference/rails/spb/create-liquidity-transfer-operation).

## Electronic money

***

The **Moeda eletrônica** screen works on the CCME of an electronic-money institution.

* **Depósito**, **Saque** and **Devolução** send a movement with [`POST /v1/str/operations/sme-transfers`](https://docs.lerian.studio/en/reference/rails/spb/create-sme-transfer-operation). The screen follows it with [`GET /v1/str/operations/sme-transfers/{operationId}`](https://docs.lerian.studio/en/reference/rails/spb/get-sme-transfer).
* **Extrato CCME** asks for the CCME statement with [`POST /v1/str/sme-statement-queries`](https://docs.lerian.studio/en/reference/rails/spb/create-sme-statement-query) and reads the answer with [`GET /v1/str/sme-statement-queries/{nuOp}`](https://docs.lerian.studio/en/reference/rails/spb/get-sme-statement-query).
* **Avisos CCME** lists the electronic-money advices that the rail received. It reads [`GET /v1/str/sme-advices`](https://docs.lerian.studio/en/reference/rails/spb/list-sme-advices).

## Operations

***

The **Operações** screen lists STR operations. It reads [`GET /v1/str/operations`](https://docs.lerian.studio/en/reference/rails/spb/list-operations). You can search by NUOp or amount, and use **Exportar CSV**.

The **Detalhe da operação** screen reads [`GET /v1/str/operations/{operationId}`](https://docs.lerian.studio/en/reference/rails/spb/get-operation). Its tabs **Linha do tempo** and **Auditoria** read [`GET /v1/str/operations/{operationId}/timeline`](https://docs.lerian.studio/en/reference/rails/spb/get-operation-timeline) and [`GET /v1/str/operations/{operationId}/audit-records`](https://docs.lerian.studio/en/reference/rails/spb/list-audit-records-for-operation). It can offer one of two actions, by the state of the transfer:

* **Devolver** returns a TED credit that the institution received, with a BACEN return code. It calls [`POST /v1/str/operations/bank-transfers/{operationId}/returns`](https://docs.lerian.studio/en/reference/rails/spb/create-bank-transfer-return-operation).
* **Cancelar operação** cancels a bank transfer. It calls [`POST /v1/str/operations/bank-transfers/{operationId}/cancellations`](https://docs.lerian.studio/en/reference/rails/spb/create-bank-transfer-cancellation-operation).

## Approvals

***

The **Aprovações** screen lists the emissions that wait for a signature. It reads [`GET /v1/str/emission-approvals`](https://docs.lerian.studio/en/reference/rails/spb/list-emission-approvals). The rules in **Governança de alçada** decide which emissions wait here. Each row offers two actions:

* **Assinar** calls [`POST /v1/str/emission-approvals/{id}/approve`](https://docs.lerian.studio/en/reference/rails/spb/approve-emission).
* **Negar** calls [`POST /v1/str/emission-approvals/{id}/deny`](https://docs.lerian.studio/en/reference/rails/spb/deny-emission).

## Recovery

***

The **Recuperação** screen, titled **Operações travadas**, lists stuck operations. It reads [`GET /v1/str/stuck-operations`](https://docs.lerian.studio/en/reference/rails/spb/list-stuck-operations). You can search, and filter by **Idade** and **Estado**. The rail decides which actions each row offers.

* **Reconhecer**, **Investigar**, **Resolver** and **Descartar** record a case action with [`POST /v1/str/reconciliations/{reconciliationId}/actions`](https://docs.lerian.studio/en/reference/rails/spb/create-reconciliation-action). **Retirar pedido** withdraws a close request through the same operation.
* **Pedir encerramento** asks to close a transfer that passed its deadline as failed. It calls [`POST /v1/str/stuck-operations/actions`](https://docs.lerian.studio/en/reference/rails/spb/submit-stuck-operation-action).
* **Aprovar encerramento** approves that request. Lerian SPB refuses the approval from the operator who asked. BACEN is not notified. It calls [`POST /v1/str/stuck-operations/actions/{railActionRef}/approve`](https://docs.lerian.studio/en/reference/rails/spb/approve-stuck-operation-action).
* **Reconhecer selecionadas** acknowledges each selected row. It makes one call to the case action operation for each row.

## Messages

***

The **Mensagens** screen lists STR messages. It reads [`GET /v1/str/messages`](https://docs.lerian.studio/en/reference/rails/spb/list-messages). You can search by NUOp, type or control number, and use **Exportar CSV**.

The **Detalhe da mensagem** screen reads [`GET /v1/str/messages/{nuOp}`](https://docs.lerian.studio/en/reference/rails/spb/get-message-status). Its tab **Campos** shows the fields. Its tab **XML assinado** reads [`GET /v1/str/messages/{nuOp}/frame`](https://docs.lerian.studio/en/reference/rails/spb/get-message-frame).

The **Nova mensagem** screen composes and sends one message. Its picker offers these types. A message that the **Governança de alçada** rules hold waits in **Aprovações**.

* **Transferir entre IFs**, **Creditar cliente**, **Enviar TED**, **Transferir não-correntista**, **Transferir cliente à IF** and **Repassar IBS** call [`POST /v1/str/messages/compose`](https://docs.lerian.studio/en/reference/rails/spb/compose-str-message).
* **Consultar horários** calls [`POST /v1/str/schedule-queries`](https://docs.lerian.studio/en/reference/rails/spb/create-schedule-query) and reads the answer with [`GET /v1/str/schedule-queries/{id}`](https://docs.lerian.studio/en/reference/rails/spb/get-schedule-query).
* **Consultar saldo** calls [`POST /v1/str/reserve-balance-queries`](https://docs.lerian.studio/en/reference/rails/spb/create-reserve-balance-query) and reads the answer with [`GET /v1/str/reserve-balance-queries/{id}`](https://docs.lerian.studio/en/reference/rails/spb/get-reserve-balance-query).
* **Consultar extrato** calls [`POST /v1/str/reserve-statement-queries`](https://docs.lerian.studio/en/reference/rails/spb/create-reserve-statement-query) and reads the answer with [`GET /v1/str/reserve-statement-queries/{id}`](https://docs.lerian.studio/en/reference/rails/spb/get-reserve-statement-query).

The **Avisos GEN** screen lists the GEN notices that the rail received. It reads [`GET /v1/str/gen-notices`](https://docs.lerian.studio/en/reference/rails/spb/list-gen-notices), and offers **Exportar CSV**.

## Evidence

***

The **Evidências** screens read what the rail recorded.

* **Consulta** finds one message by NUOp. It reads [`GET /v1/str/messages/{nuOp}`](https://docs.lerian.studio/en/reference/rails/spb/get-message-status).
* **Relatórios** builds **Movimento financeiro**, **Volumetria** or **Transações rejeitadas** for a period, with **Gerar relatório**. The reports read [`GET /v1/str/reports/movement`](https://docs.lerian.studio/en/reference/rails/spb/get-report-movement), [`GET /v1/str/reports/volumetria`](https://docs.lerian.studio/en/reference/rails/spb/get-report-volumetria) and [`GET /v1/str/reports/rejected`](https://docs.lerian.studio/en/reference/rails/spb/get-report-rejected).
* **Catálogo**, titled **Capacidades**, lists the capabilities of the rail with [`GET /v1/str/capabilities`](https://docs.lerian.studio/en/reference/rails/spb/list-capabilities). One capability opens [`GET /v1/str/capabilities/{capabilityId}`](https://docs.lerian.studio/en/reference/rails/spb/get-capability).
* **Conciliação** lists reconciliation cases with [`GET /v1/str/reconciliations`](https://docs.lerian.studio/en/reference/rails/spb/list-reconciliation-cases). A case reads [`GET /v1/str/reconciliations/{reconciliationId}`](https://docs.lerian.studio/en/reference/rails/spb/get-reconciliation-case). Its case actions are under [Recovery](#recovery).
* **Auditoria** lists audit records with [`GET /v1/str/audit-records`](https://docs.lerian.studio/en/reference/rails/spb/list-audit-records), and offers **Exportar CSV**.

## Configuration

***

The **Configuração** screen has three sections. **Reserva** holds the operating floors (see [Configuring Lerian Cabine](https://docs.lerian.studio/en/rails/cabine/cabine-configuration.md)). **Canal** shows the link of the participant, read with [`GET /v1/str/settings`](https://docs.lerian.studio/en/reference/rails/spb/get-settings). **Certificados** lists the certificates, read with [`GET /v1/str/certificates`](https://docs.lerian.studio/en/reference/rails/spb/list-certificates).

* **Salvar alterações** in the channel form calls [`PATCH /v1/str/settings`](https://docs.lerian.studio/en/reference/rails/spb/update-settings).
* **Rotacionar certificado (GEN0006)** has two steps. **Rotacionar** calls [`POST /v1/str/certificates/rotate`](https://docs.lerian.studio/en/reference/rails/spb/rotate-certificate). **Ativar** calls [`POST /v1/str/certificates/activate`](https://docs.lerian.studio/en/reference/rails/spb/activate-certificate).
* **Testar conectividade** sends a connectivity test with [`POST /v1/str/connectivity-tests`](https://docs.lerian.studio/en/reference/rails/spb/create-connectivity-test).

Three screens sit under **Configuração**:

* **Governança de alçada** sets **Faixas de valor** and **Por mensagem** rules. It reads [`GET /v1/str/governance`](https://docs.lerian.studio/en/reference/rails/spb/get-str-governance) and saves with [`PUT /v1/str/governance`](https://docs.lerian.studio/en/reference/rails/spb/put-str-governance).
* **Transferência automática** sets the Conta PI auto-transfer for **Reservas (RB/CL)** and **Moeda eletrônica (CCME)**. It calls [`POST /v1/str/operations/auto-transfer-config`](https://docs.lerian.studio/en/reference/rails/spb/create-auto-transfer-config).
* **Responsáveis** sends the **Roster** of responsible people. It calls [`POST /v1/str/responsibles`](https://docs.lerian.studio/en/reference/rails/spb/update-responsibles).

**XML assinado** needs `str-message-frames:read`. Channel edits need `str-settings:write`, and certificate rotation needs `str-certificates:rotate`. The roster needs `str-responsibles:submit`.

## Related

***

* [Operating Lerian SPB](https://docs.lerian.studio/en/rails/spb/spb-operations.md)
* [Access and roles in Lerian Cabine](https://docs.lerian.studio/en/rails/cabine/cabine-access-and-roles.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.