> ## 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 no Cabine

> A área de trabalho do Lerian SPI no Lerian Cabine.

A área de trabalho do Lerian SPI no Lerian Cabine aparece como **SPI**. Os operadores a usam para acompanhar pagamentos Pix, movimentar a liquidez da Conta PI e trabalhar com chaves e reivindicações do DICT. Eles também tratam casos do MED, consultam o Pix Automático, gerenciam cobranças BR Code e enviam mensagens do SPI.

## Visão geral

***

A tela **Visão geral** conta o que pede atenção: **Alarmes de participante**, **Pagamentos pendentes** e **Reivindicações aguardando ação**. Ela também mostra a prontidão do trilho. Ela lê [`GET /api/v1/spi/payments`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-payments), [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-stuck-operations) e [`GET /api/v1/dict/claims`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-claims). **Abrir pagamentos** abre a lista de pagamentos.

## Dinheiro

***

A tela **Pagamentos** lista os pagamentos Pix. Ela lê [`GET /api/v1/spi/payments`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-payments). Você pode buscar por EndToEndID, valor ou ISPB e usar **Exportar CSV**.

A tela **Detalhe do pagamento** lê [`GET /api/v1/spi/payments/{endToEndID}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-payment) e [`GET /api/v1/spi/payments/{endToEndID}/history`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-payment-history). As abas **Eventos**, **Linha do tempo** e **Evidências** leem [`GET /api/v1/spi/operations/{operationId}/timeline`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-operation-timeline) e [`GET /api/v1/spi/operations/{operationId}/evidence`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-operation-evidence). Ela oferece duas ações:

* **Devolver** devolve o valor integral ao pagador e movimenta a Conta PI. Ela chama [`POST /api/v1/spi/payments/{endToEndID}/returns`](https://docs.lerian.studio/pt/reference/rails/spi/spi/initiate-payment-return).
* **Exportar evidência** gera um artefato com a evidência registrada. Ela chama [`POST /api/v1/spi/evidence/exports`](https://docs.lerian.studio/pt/reference/rails/spi/spi/create-evidence-export) e acompanha a exportação com [`GET /api/v1/spi/evidence/exports/{exportId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-evidence-export).

A tela **Conta PI** mostra o saldo e o extrato da Conta PI. Ela os pede com [`POST /api/v1/spi/account-reports/requests`](https://docs.lerian.studio/pt/reference/rails/spi/spi/create-account-report-request) e os lê com [`GET /api/v1/spi/account-reports/{correlationId}/balance`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-account-report-balance) e [`GET /api/v1/spi/account-reports/{correlationId}/extract`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-account-report-extract). **Baixar extrato (CSV)** e **Atualizar extrato** atuam sobre o extrato.

* **Movimentar** abre **Aporte ou resgate**. Ela movimenta a liquidez com [`POST /v1/str/operations/liquidity-transfers`](https://docs.lerian.studio/pt/reference/rails/spb/create-liquidity-transfer-operation), uma operação do Lerian SPB.

A tela **Pix recebidos** lista os Pix que a instituição recebeu, com as devoluções de cada um. Ela lê [`POST /api/v1/spi/pix`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-received-pix). As janelas são **Hoje**, **Últimas 24h** e **Últimos 7 dias**.

## Casos

***

A tela **Autorizações**, com o título **Aprovações**, trata as aprovações. Você busca uma aprovação pelo id com [`GET /api/v1/spi/approvals/{approvalId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-approval).

* **Solicitar aprovação** pede uma aprovação que outro operador decide. Ela chama [`POST /api/v1/spi/approvals`](https://docs.lerian.studio/pt/reference/rails/spi/spi/create-approval).
* **Aprovar** e **Negar** decidem uma aprovação. Elas chamam [`POST /api/v1/spi/approvals/{approvalId}/decision`](https://docs.lerian.studio/pt/reference/rails/spi/spi/decide-approval). O trilho recusa a decisão de quem solicitou a aprovação.

A tela **Recuperação**, com o título **Operações travadas**, lista as operações travadas. Ela lê [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-stuck-operations). O trilho decide quais ações cada linha oferece.

* **Resolver manualmente** chama [`POST /api/v1/spi/operations/{operationId}/recovery/manual-resolution`](https://docs.lerian.studio/pt/reference/rails/spi/spi/manual-resolve-operation). Ela pede o id de uma aprovação de **Autorizações**.
* **Consultar BACEN**, **Investigar**, **Reconhecer**, **Resolver** e **Descartar** chamam [`POST /api/v1/spi/operations/stuck/actions`](https://docs.lerian.studio/pt/reference/rails/spi/spi/submit-stuck-operation-action).

A tela **MED** trata casos de fraude e devolução. Suas abas leem o DICT. Cada aba lista seus registros e oferece ações:

* **Infrações** lê [`GET /api/v1/dict/infractions`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-infractions). **Reconhecer**, **Encerrar** e **Cancelar** chamam [`POST /api/v1/dict/infractions/{id}/acknowledge`](https://docs.lerian.studio/pt/reference/rails/spi/dict/acknowledge-infraction), [`POST /api/v1/dict/infractions/{id}/close`](https://docs.lerian.studio/pt/reference/rails/spi/dict/close-infraction) e [`POST /api/v1/dict/infractions/{id}/cancel`](https://docs.lerian.studio/pt/reference/rails/spi/dict/cancel-infraction).
* **Devoluções** lê [`GET /api/v1/dict/refunds`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-refunds). **Registrar devolução** chama [`POST /api/v1/dict/refunds`](https://docs.lerian.studio/pt/reference/rails/spi/dict/create-refund). **Analisar** e **Cancelar** chamam [`POST /api/v1/dict/refunds/{id}/close`](https://docs.lerian.studio/pt/reference/rails/spi/dict/close-refund) e [`POST /api/v1/dict/refunds/{id}/cancel`](https://docs.lerian.studio/pt/reference/rails/spi/dict/cancel-refund).
* **Marcadores de fraude** lê [`GET /api/v1/dict/fraud-markers`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-fraud-markers). **Registrar marcador** chama [`POST /api/v1/dict/fraud-markers`](https://docs.lerian.studio/pt/reference/rails/spi/dict/create-fraud-marker). **Cancelar** chama [`POST /api/v1/dict/fraud-markers/{id}/cancel`](https://docs.lerian.studio/pt/reference/rails/spi/dict/cancel-fraud-marker).
* **Recuperação de fundos** lê [`GET /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-funds-recoveries). **Abrir recuperação** chama [`POST /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/pt/reference/rails/spi/dict/create-funds-recovery). No detalhe, **Cancelar recuperação** chama [`POST /api/v1/dict/funds-recoveries/{id}/cancel`](https://docs.lerian.studio/pt/reference/rails/spi/dict/cancel-funds-recovery), e **Solicitar devolução** chama [`POST /api/v1/dict/funds-recoveries/{id}/refund`](https://docs.lerian.studio/pt/reference/rails/spi/dict/create-funds-recovery-refund).

## Rede

***

A tela **Participantes**, com o título **Participantes indiretos**, lista os participantes indiretos. Ela lê [`GET /api/v1/core/participants/`](https://docs.lerian.studio/pt/reference/rails/spi/core/list-participants).

* **Credenciar** credencia um participante com [`POST /api/v1/core/participants/`](https://docs.lerian.studio/pt/reference/rails/spi/core/register-participant).
* **Contatos** envia os contatos com [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/pt/reference/rails/spi/spi/register-responsibles). **Contato MED** chama [`PUT /api/v1/core/participants/{ispb}/contact`](https://docs.lerian.studio/pt/reference/rails/spi/core/update-participant-contact).
* **Descredenciar**, **Suspender** e **Reativar** chamam [`POST /api/v1/core/participants/{ispb}/offboard`](https://docs.lerian.studio/pt/reference/rails/spi/core/offboard-participant), [`POST /api/v1/core/participants/{ispb}/suspend`](https://docs.lerian.studio/pt/reference/rails/spi/core/suspend-participant) e [`POST /api/v1/core/participants/{ispb}/activate`](https://docs.lerian.studio/pt/reference/rails/spi/core/activate-participant).
* **Confirmar encerramento** no alarme de portabilidade chama a operação de descredenciamento.

A tela **Responsáveis**, com o título **Responsáveis Conta PI**, mostra os responsáveis registrados. Ela lê [`GET /api/v1/spi/responsibles`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-responsibles). **Registrar** ou **Editar** envia os contatos com [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/pt/reference/rails/spi/spi/register-responsibles).

A tela **DICT**, com o título **Chaves DICT**, lista as chaves Pix. Ela lê [`GET /api/v1/dict/keys`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-keys), [`GET /api/v1/dict/keys/search`](https://docs.lerian.studio/pt/reference/rails/spi/dict/search-keys) e [`GET /api/v1/dict/keys/stats`](https://docs.lerian.studio/pt/reference/rails/spi/dict/key-stats).

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

A tela **Reivindicações** lista as reivindicações. Ela lê [`GET /api/v1/dict/claims`](https://docs.lerian.studio/pt/reference/rails/spi/dict/list-claims). As visões são **Todas**, **Enviadas** e **Recebidas**. **Iniciar reivindicação** chama [`POST /api/v1/dict/participants/{participantISPB}/claims`](https://docs.lerian.studio/pt/reference/rails/spi/dict/initiate-claim).

A tela **Detalhe da reivindicação** lê [`GET /api/v1/dict/claims/{claimID}`](https://docs.lerian.studio/pt/reference/rails/spi/dict/get-claim). Ela oferece as decisões que se aplicam à reivindicação para a instituição. Cada decisão chama uma operação:

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

## Produtos

***

A tela **Pix Automático** é somente de leitura. **Mandatos** lê [`GET /api/v1/spi/mandates`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-mandates) e [`GET /api/v1/spi/mandates/{mandateId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-mandate). **Agendamentos** lê [`GET /api/v1/spi/scheduled-payments`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-schedules) e [`GET /api/v1/spi/scheduled-payments/{scheduleId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-schedule).

A tela **BR Code** tem oito visões. Cada visão lê seus registros, e algumas visões os criam ou alteram.

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

## Mensagens

***

A tela **Mensagens** lista as mensagens do SPI. Ela lê [`GET /api/v1/spi/messages`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-message-log), e **Detalhe da mensagem** lê [`GET /api/v1/spi/messages/{messageRecordId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-message-log-detail). Você pode usar **Exportar CSV**. **Testar conectividade** chama [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/pt/reference/rails/spi/spi/create-connectivity-test).

A tela **Nova mensagem** envia uma mensagem. Sua lista oferece estes tipos:

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

## Evidências

***

* **Consulta** encontra as mensagens de uma transação pela chave de negócio. Ela lê [`GET /api/v1/spi/messages`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-message-log).
* **Relatórios** gera um relatório para um período, com **Gerar relatório**. Os relatórios são **Volumetria PIX**, **Transações rejeitadas**, **DICT · chaves**, **DICT · reivindicações**, **Conta PI · saldos** e **Conta PI · extratos**. Eles leem [`GET /api/v1/spi/reports/volumetria`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-spi-report-volumetria), [`GET /api/v1/spi/reports/rejected`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-spi-report-rejected), [`GET /api/v1/dict/reports/keys-summary`](https://docs.lerian.studio/pt/reference/rails/spi/dict/get-dict-report-keys-summary), [`GET /api/v1/dict/reports/claims-summary`](https://docs.lerian.studio/pt/reference/rails/spi/dict/get-dict-report-claims-summary), [`GET /api/v1/spi/reports/balances`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-spi-report-balances) e [`GET /api/v1/spi/reports/extracts`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-spi-report-extracts).
* **Catálogo**, com o título **Capacidades**, lista as capacidades do trilho com [`GET /api/v1/spi/capabilities`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-spi-capabilities). Uma capacidade abre [`GET /api/v1/spi/capabilities/{capabilityId}`](https://docs.lerian.studio/pt/reference/rails/spi/spi/get-spi-capability).

## Configuração

***

A tela **Configuração** tem duas seções. **Certificados** lista os certificados Pix, lidos com [`GET /api/v1/spi/certificates`](https://docs.lerian.studio/pt/reference/rails/spi/spi/list-pix-certificates). **Limiares** guarda os limiares operacionais (veja [Configurando o Lerian Cabine](https://docs.lerian.studio/pt/rails/cabine/cabine-configuration.md)). **Testar conectividade** chama [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/pt/reference/rails/spi/spi/create-connectivity-test).

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

## Relacionados

***

* [Como o Lerian SPI funciona](https://docs.lerian.studio/pt/rails/spi/how-spi-works.md)
* [Acesso e papéis no Lerian Cabine](https://docs.lerian.studio/pt/rails/cabine/cabine-access-and-roles.md)


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