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

# SPI in Cabine

> The Lerian SPI workspace in Lerian Cabine.

The Lerian Cabine workspace for Lerian SPI shows as **SPI**. Operators use it to follow Pix payments, move Conta PI liquidity and work with DICT keys and claims. They also handle MED cases, read Pix Automático, manage BR Code charges and send SPI messages.

## Overview

***

The **Visão geral** screen counts what needs attention: **Alarmes de participante**, **Pagamentos pendentes** and **Reivindicações aguardando ação**. It also shows the readiness of the rail. It reads [`GET /api/v1/spi/payments`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-payments), [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-stuck-operations) and [`GET /api/v1/dict/claims`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-claims). **Abrir pagamentos** opens the payments list.

## Money

***

The **Pagamentos** screen lists Pix payments. It reads [`GET /api/v1/spi/payments`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-payments). You can search by EndToEndID, amount or ISPB, and use **Exportar CSV**.

The **Detalhe do pagamento** screen reads [`GET /api/v1/spi/payments/{endToEndID}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-payment) and [`GET /api/v1/spi/payments/{endToEndID}/history`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-payment-history). Its tabs **Eventos**, **Linha do tempo** and **Evidências** read [`GET /api/v1/spi/operations/{operationId}/timeline`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-operation-timeline) and [`GET /api/v1/spi/operations/{operationId}/evidence`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-operation-evidence). It offers two actions:

* **Devolver** returns the full amount to the payer and moves the Conta PI. It calls [`POST /api/v1/spi/payments/{endToEndID}/returns`](https://docs.lerian.studio/en/reference/rails/spi/spi/initiate-payment-return).
* **Exportar evidência** builds an artifact from the recorded evidence. It calls [`POST /api/v1/spi/evidence/exports`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-evidence-export) and follows the export with [`GET /api/v1/spi/evidence/exports/{exportId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-evidence-export).

The **Conta PI** screen shows the balance and the statement of the Conta PI. It asks for them with [`POST /api/v1/spi/account-reports/requests`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-account-report-request) and reads them with [`GET /api/v1/spi/account-reports/{correlationId}/balance`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-account-report-balance) and [`GET /api/v1/spi/account-reports/{correlationId}/extract`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-account-report-extract). **Baixar extrato (CSV)** and **Atualizar extrato** work on the statement.

* **Movimentar** opens **Aporte ou resgate**. It moves liquidity with [`POST /v1/str/operations/liquidity-transfers`](https://docs.lerian.studio/en/reference/rails/spb/create-liquidity-transfer-operation), a Lerian SPB operation.

The **Pix recebidos** screen lists the Pix that the institution received, with the returns of each one. It reads [`POST /api/v1/spi/pix`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-received-pix). The windows are **Hoje**, **Últimas 24h** and **Últimos 7 dias**.

## Cases

***

The **Autorizações** screen, titled **Aprovações**, handles approvals. You look an approval up by its id with [`GET /api/v1/spi/approvals/{approvalId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-approval).

* **Solicitar aprovação** asks for an approval that another operator decides. It calls [`POST /api/v1/spi/approvals`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-approval).
* **Aprovar** and **Negar** decide an approval. They call [`POST /api/v1/spi/approvals/{approvalId}/decision`](https://docs.lerian.studio/en/reference/rails/spi/spi/decide-approval). The rail refuses a decision from the person who requested the approval.

The **Recuperação** screen, titled **Operações travadas**, lists stuck operations. It reads [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-stuck-operations). The rail decides which actions each row offers.

* **Resolver manualmente** calls [`POST /api/v1/spi/operations/{operationId}/recovery/manual-resolution`](https://docs.lerian.studio/en/reference/rails/spi/spi/manual-resolve-operation). It asks for the id of an approval from **Autorizações**.
* **Consultar BACEN**, **Investigar**, **Reconhecer**, **Resolver** and **Descartar** call [`POST /api/v1/spi/operations/stuck/actions`](https://docs.lerian.studio/en/reference/rails/spi/spi/submit-stuck-operation-action).

The **MED** screen works on fraud and return cases. Its tabs read the DICT. Each tab lists its records and offers actions:

* **Infrações** reads [`GET /api/v1/dict/infractions`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-infractions). **Reconhecer**, **Encerrar** and **Cancelar** call [`POST /api/v1/dict/infractions/{id}/acknowledge`](https://docs.lerian.studio/en/reference/rails/spi/dict/acknowledge-infraction), [`POST /api/v1/dict/infractions/{id}/close`](https://docs.lerian.studio/en/reference/rails/spi/dict/close-infraction) and [`POST /api/v1/dict/infractions/{id}/cancel`](https://docs.lerian.studio/en/reference/rails/spi/dict/cancel-infraction).
* **Devoluções** reads [`GET /api/v1/dict/refunds`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-refunds). **Registrar devolução** calls [`POST /api/v1/dict/refunds`](https://docs.lerian.studio/en/reference/rails/spi/dict/create-refund). **Analisar** and **Cancelar** call [`POST /api/v1/dict/refunds/{id}/close`](https://docs.lerian.studio/en/reference/rails/spi/dict/close-refund) and [`POST /api/v1/dict/refunds/{id}/cancel`](https://docs.lerian.studio/en/reference/rails/spi/dict/cancel-refund).
* **Marcadores de fraude** reads [`GET /api/v1/dict/fraud-markers`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-fraud-markers). **Registrar marcador** calls [`POST /api/v1/dict/fraud-markers`](https://docs.lerian.studio/en/reference/rails/spi/dict/create-fraud-marker). **Cancelar** calls [`POST /api/v1/dict/fraud-markers/{id}/cancel`](https://docs.lerian.studio/en/reference/rails/spi/dict/cancel-fraud-marker).
* **Recuperação de fundos** reads [`GET /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-funds-recoveries). **Abrir recuperação** calls [`POST /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/en/reference/rails/spi/dict/create-funds-recovery). In the detail, **Cancelar recuperação** calls [`POST /api/v1/dict/funds-recoveries/{id}/cancel`](https://docs.lerian.studio/en/reference/rails/spi/dict/cancel-funds-recovery), and **Solicitar devolução** calls [`POST /api/v1/dict/funds-recoveries/{id}/refund`](https://docs.lerian.studio/en/reference/rails/spi/dict/create-funds-recovery-refund).

## Network

***

The **Participantes** screen, titled **Participantes indiretos**, lists the indirect participants. It reads [`GET /api/v1/core/participants/`](https://docs.lerian.studio/en/reference/rails/spi/core/list-participants).

* **Credenciar** enrolls a participant with [`POST /api/v1/core/participants/`](https://docs.lerian.studio/en/reference/rails/spi/core/register-participant).
* **Contatos** sends the contacts with [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/en/reference/rails/spi/spi/register-responsibles). **Contato MED** calls [`PUT /api/v1/core/participants/{ispb}/contact`](https://docs.lerian.studio/en/reference/rails/spi/core/update-participant-contact).
* **Descredenciar**, **Suspender** and **Reativar** call [`POST /api/v1/core/participants/{ispb}/offboard`](https://docs.lerian.studio/en/reference/rails/spi/core/offboard-participant), [`POST /api/v1/core/participants/{ispb}/suspend`](https://docs.lerian.studio/en/reference/rails/spi/core/suspend-participant) and [`POST /api/v1/core/participants/{ispb}/activate`](https://docs.lerian.studio/en/reference/rails/spi/core/activate-participant).
* **Confirmar encerramento** in the portability alarm calls the offboard operation.

The **Responsáveis** screen, titled **Responsáveis Conta PI**, shows the registered responsible people. It reads [`GET /api/v1/spi/responsibles`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-responsibles). **Registrar** or **Editar** sends the contacts with [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/en/reference/rails/spi/spi/register-responsibles).

The **DICT** screen, titled **Chaves DICT**, lists Pix keys. It reads [`GET /api/v1/dict/keys`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-keys), [`GET /api/v1/dict/keys/search`](https://docs.lerian.studio/en/reference/rails/spi/dict/search-keys) and [`GET /api/v1/dict/keys/stats`](https://docs.lerian.studio/en/reference/rails/spi/dict/key-stats).

* **Registrar chave** calls [`POST /api/v1/dict/keys`](https://docs.lerian.studio/en/reference/rails/spi/dict/register-key).
* **Consultar chave** calls [`POST /api/v1/dict/keys/lookup`](https://docs.lerian.studio/en/reference/rails/spi/dict/lookup-key). **Verificar em lote** calls [`POST /api/v1/dict/keys/check`](https://docs.lerian.studio/en/reference/rails/spi/dict/check-keys).
* **Editar** calls [`PUT /api/v1/dict/keys/{key}`](https://docs.lerian.studio/en/reference/rails/spi/dict/update-key). **Excluir** calls [`DELETE /api/v1/dict/keys`](https://docs.lerian.studio/en/reference/rails/spi/dict/delete-key).

The **Reivindicações** screen lists the claims. It reads [`GET /api/v1/dict/claims`](https://docs.lerian.studio/en/reference/rails/spi/dict/list-claims). The views are **Todas**, **Enviadas** and **Recebidas**. **Iniciar reivindicação** calls [`POST /api/v1/dict/participants/{participantISPB}/claims`](https://docs.lerian.studio/en/reference/rails/spi/dict/initiate-claim).

The **Detalhe da reivindicação** screen reads [`GET /api/v1/dict/claims/{claimID}`](https://docs.lerian.studio/en/reference/rails/spi/dict/get-claim). It offers the decisions that apply to the claim for the institution. Each decision calls one operation:

* **Reconhecer** calls [`POST /api/v1/dict/claims/{claimID}/acknowledge`](https://docs.lerian.studio/en/reference/rails/spi/dict/acknowledge-claim).
* **Confirmar** calls [`POST /api/v1/dict/claims/{claimID}/confirm`](https://docs.lerian.studio/en/reference/rails/spi/dict/confirm-claim).
* **Rejeitar** calls [`POST /api/v1/dict/claims/{claimID}/reject`](https://docs.lerian.studio/en/reference/rails/spi/dict/reject-claim).
* **Cancelar** calls [`POST /api/v1/dict/claims/{claimID}/cancel`](https://docs.lerian.studio/en/reference/rails/spi/dict/cancel-claim).
* **Concluir** calls [`POST /api/v1/dict/claims/{claimID}/complete`](https://docs.lerian.studio/en/reference/rails/spi/dict/complete-claim).

## Products

***

The **Pix Automático** screen is read-only. **Mandatos** reads [`GET /api/v1/spi/mandates`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-mandates) and [`GET /api/v1/spi/mandates/{mandateId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-mandate). **Agendamentos** reads [`GET /api/v1/spi/scheduled-payments`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-schedules) and [`GET /api/v1/spi/scheduled-payments/{scheduleId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-schedule).

The **BR Code** screen has eight views. Each view reads its records, and some views create or change them.

| View | Reads | Writes |
| - | - | - |
| **Cobranças imediatas** | [`GET /api/v1/brcode/cob`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-cob), [`GET /api/v1/brcode/cob/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-cob) | [`POST /api/v1/brcode/cob`](https://docs.lerian.studio/en/reference/rails/spi/brcode/post-cob), [`PUT /api/v1/brcode/cob/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/put-cob), [`PATCH /api/v1/brcode/cob/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/patch-cob) |
| **Cobranças com vencimento** | [`GET /api/v1/brcode/cobv`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-cob-v), [`GET /api/v1/brcode/cobv/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-cob-v) | [`PUT /api/v1/brcode/cobv/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/put-cob-v), [`PATCH /api/v1/brcode/cobv/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/patch-cob-v) |
| **Cobranças recorrentes** | [`GET /api/v1/brcode/cobr`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-cob-r), [`GET /api/v1/brcode/cobr/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-cob-r) | [`POST /api/v1/brcode/cobr`](https://docs.lerian.studio/en/reference/rails/spi/brcode/post-cob-r), [`PUT /api/v1/brcode/cobr/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/put-cob-r), [`PATCH /api/v1/brcode/cobr/{txid}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/patch-cob-r), [`POST /api/v1/brcode/cobr/{txid}/retentativa/{data}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/post-cob-r-retentativa) |
| **Recorrências** | [`GET /api/v1/brcode/rec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-rec), [`GET /api/v1/brcode/rec/{idRec}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-rec) | [`POST /api/v1/brcode/rec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/post-rec), [`PATCH /api/v1/brcode/rec/{idRec}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/patch-rec) |
| **Solicitações de confirmação** | [`GET /api/v1/brcode/solicrec/{idSolicRec}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-solic-rec) | [`POST /api/v1/brcode/solicrec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/post-solic-rec), [`PATCH /api/v1/brcode/solicrec/{idSolicRec}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/patch-solic-rec) |
| **Locations de payload** | [`GET /api/v1/brcode/loc`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-location), [`GET /api/v1/brcode/loc/{id}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-location) | [`POST /api/v1/brcode/loc`](https://docs.lerian.studio/en/reference/rails/spi/brcode/create-location), [`DELETE /api/v1/brcode/loc/{id}/txid`](https://docs.lerian.studio/en/reference/rails/spi/brcode/delete-location-tx-id) |
| **Locations de recorrência** | [`GET /api/v1/brcode/locrec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-location-rec), [`GET /api/v1/brcode/locrec/{id}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-location-rec) | [`POST /api/v1/brcode/locrec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/create-location-rec), [`DELETE /api/v1/brcode/locrec/{id}/idRec`](https://docs.lerian.studio/en/reference/rails/spi/brcode/delete-location-rec-id-rec) |
| **Lotes de cobrança** | [`GET /api/v1/brcode/lotecobv`](https://docs.lerian.studio/en/reference/rails/spi/brcode/list-lote-cob-v), [`GET /api/v1/brcode/lotecobv/{id}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/get-lote-cob-v) | [`PUT /api/v1/brcode/lotecobv/{id}`](https://docs.lerian.studio/en/reference/rails/spi/brcode/put-lote-cob-v) |

## Messages

***

The **Mensagens** screen lists SPI messages. It reads [`GET /api/v1/spi/messages`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-message-log), and **Detalhe da mensagem** reads [`GET /api/v1/spi/messages/{messageRecordId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-message-log-detail). You can use **Exportar CSV**. **Testar conectividade** calls [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-connectivity-test).

The **Nova mensagem** screen sends one message. Its picker offers these types:

| Type | Operation |
| - | - |
| **Consultar Conta PI** (`camt.060`) | [`POST /api/v1/spi/account-reports/requests`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-account-report-request) |
| **Devolver pagamento** (`pacs.004`) | [`POST /api/v1/spi/payments/{endToEndID}/returns`](https://docs.lerian.studio/en/reference/rails/spi/spi/initiate-payment-return) |
| **Cancelar recorrência** (`pain.011`) | [`POST /api/v1/spi/mandates/cancellations`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-mandate-cancellation) |
| **Informar status da cobrança** (`pain.014`) | [`POST /api/v1/spi/scheduled-payments/resolutions`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-scheduled-payment-resolution) |
| **Reportar rastreio** (`trck.002`) | [`POST /api/v1/spi/settlement-reports`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-settlement-report) |
| **Resolver cancelamento** (`camt.029`) | [`POST /api/v1/spi/scheduled-payments/cancellations/resolutions`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-schedule-cancellation-resolution) |
| **Solicitar cancelamento** (`camt.055`) | [`POST /api/v1/spi/scheduled-payments/cancellations`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-schedule-cancellation) |
| **Testar conectividade** (`pibr.001`) | [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-connectivity-test) |
| **Credenciar liquidante** (`reda.014`) | [`POST /api/v1/core/participants/`](https://docs.lerian.studio/en/reference/rails/spi/core/register-participant) |
| **Atualizar responsáveis** (`reda.022`) | [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/en/reference/rails/spi/spi/register-responsibles) |
| **Descredenciar liquidante** (`reda.031`) | [`POST /api/v1/core/participants/{ispb}/offboard`](https://docs.lerian.studio/en/reference/rails/spi/core/offboard-participant) |

## Evidence

***

* **Consulta** finds the messages of one transaction by its business key. It reads [`GET /api/v1/spi/messages`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-message-log).
* **Relatórios** builds a report for a period, with **Gerar relatório**. The reports are **Volumetria PIX**, **Transações rejeitadas**, **DICT · chaves**, **DICT · reivindicações**, **Conta PI · saldos** and **Conta PI · extratos**. They read [`GET /api/v1/spi/reports/volumetria`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-spi-report-volumetria), [`GET /api/v1/spi/reports/rejected`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-spi-report-rejected), [`GET /api/v1/dict/reports/keys-summary`](https://docs.lerian.studio/en/reference/rails/spi/dict/get-dict-report-keys-summary), [`GET /api/v1/dict/reports/claims-summary`](https://docs.lerian.studio/en/reference/rails/spi/dict/get-dict-report-claims-summary), [`GET /api/v1/spi/reports/balances`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-spi-report-balances) and [`GET /api/v1/spi/reports/extracts`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-spi-report-extracts).
* **Catálogo**, titled **Capacidades**, lists the capabilities of the rail with [`GET /api/v1/spi/capabilities`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-spi-capabilities). One capability opens [`GET /api/v1/spi/capabilities/{capabilityId}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-spi-capability).

## Configuration

***

The **Configuração** screen has two sections. **Certificados** lists the Pix certificates, read with [`GET /api/v1/spi/certificates`](https://docs.lerian.studio/en/reference/rails/spi/spi/list-pix-certificates). **Limiares** holds the operating thresholds (see [Configuring Lerian Cabine](https://docs.lerian.studio/en/rails/cabine/cabine-configuration.md)). **Testar conectividade** calls [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/en/reference/rails/spi/spi/create-connectivity-test).

* **Importar certificado** calls [`POST /api/v1/spi/certificates`](https://docs.lerian.studio/en/reference/rails/spi/spi/upload-pix-certificate). A certificate opens [`GET /api/v1/spi/certificates/{id}`](https://docs.lerian.studio/en/reference/rails/spi/spi/get-pix-certificate).
* **Desativar** calls [`DELETE /api/v1/spi/certificates/{id}`](https://docs.lerian.studio/en/reference/rails/spi/spi/deactivate-pix-certificate).

## Related

***

* [How Lerian SPI works](https://docs.lerian.studio/en/rails/spi/how-spi-works.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.