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

> El espacio de trabajo de Lerian SPI en Lerian Cabine.

El espacio de trabajo de Lerian SPI en Lerian Cabine aparece como **SPI**. Los operadores lo usan para seguir pagos Pix, mover la liquidez de la Conta PI y trabajar con claves y reivindicaciones del DICT. También atienden casos del MED, consultan Pix Automático, gestionan cobros BR Code y envían mensajes del SPI.

## Resumen

***

La pantalla **Visão geral** cuenta lo que pide atención: **Alarmes de participante**, **Pagamentos pendentes** y **Reivindicações aguardando ação**. También muestra la preparación del riel. Lee [`GET /api/v1/spi/payments`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-payments), [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-stuck-operations) y [`GET /api/v1/dict/claims`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-claims). **Abrir pagamentos** abre la lista de pagos.

## Dinero

***

La pantalla **Pagamentos** lista los pagos Pix. Lee [`GET /api/v1/spi/payments`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-payments). Puedes buscar por EndToEndID, valor o ISPB y usar **Exportar CSV**.

La pantalla **Detalhe do pagamento** lee [`GET /api/v1/spi/payments/{endToEndID}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-payment) y [`GET /api/v1/spi/payments/{endToEndID}/history`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-payment-history). Sus pestañas **Eventos**, **Linha do tempo** y **Evidências** leen [`GET /api/v1/spi/operations/{operationId}/timeline`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-operation-timeline) y [`GET /api/v1/spi/operations/{operationId}/evidence`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-operation-evidence). Ofrece dos acciones:

* **Devolver** devuelve el valor íntegro al pagador y mueve la Conta PI. Llama a [`POST /api/v1/spi/payments/{endToEndID}/returns`](https://docs.lerian.studio/es/reference/rails/spi/spi/initiate-payment-return).
* **Exportar evidência** genera un artefacto con la evidencia registrada. Llama a [`POST /api/v1/spi/evidence/exports`](https://docs.lerian.studio/es/reference/rails/spi/spi/create-evidence-export) y sigue la exportación con [`GET /api/v1/spi/evidence/exports/{exportId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-evidence-export).

La pantalla **Conta PI** muestra el saldo y el extracto de la Conta PI. Los pide con [`POST /api/v1/spi/account-reports/requests`](https://docs.lerian.studio/es/reference/rails/spi/spi/create-account-report-request) y los lee con [`GET /api/v1/spi/account-reports/{correlationId}/balance`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-account-report-balance) y [`GET /api/v1/spi/account-reports/{correlationId}/extract`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-account-report-extract). **Baixar extrato (CSV)** y **Atualizar extrato** actúan sobre el extracto.

* **Movimentar** abre **Aporte ou resgate**. Mueve la liquidez con [`POST /v1/str/operations/liquidity-transfers`](https://docs.lerian.studio/es/reference/rails/spb/create-liquidity-transfer-operation), una operación de Lerian SPB.

La pantalla **Pix recebidos** lista los Pix que la institución recibió, con las devoluciones de cada uno. Lee [`POST /api/v1/spi/pix`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-received-pix). Las ventanas son **Hoje**, **Últimas 24h** y **Últimos 7 dias**.

## Casos

***

La pantalla **Autorizações**, con el título **Aprovações**, gestiona las aprobaciones. Buscas una aprobación por su id con [`GET /api/v1/spi/approvals/{approvalId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-approval).

* **Solicitar aprovação** pide una aprobación que decide otro operador. Llama a [`POST /api/v1/spi/approvals`](https://docs.lerian.studio/es/reference/rails/spi/spi/create-approval).
* **Aprovar** y **Negar** deciden una aprobación. Llaman a [`POST /api/v1/spi/approvals/{approvalId}/decision`](https://docs.lerian.studio/es/reference/rails/spi/spi/decide-approval). El riel rechaza la decisión de quien solicitó la aprobación.

La pantalla **Recuperação**, con el título **Operações travadas**, lista las operaciones atascadas. Lee [`GET /api/v1/spi/operations/stuck`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-stuck-operations). El riel decide qué acciones ofrece cada fila.

* **Resolver manualmente** llama a [`POST /api/v1/spi/operations/{operationId}/recovery/manual-resolution`](https://docs.lerian.studio/es/reference/rails/spi/spi/manual-resolve-operation). Pide el id de una aprobación de **Autorizações**.
* **Consultar BACEN**, **Investigar**, **Reconhecer**, **Resolver** y **Descartar** llaman a [`POST /api/v1/spi/operations/stuck/actions`](https://docs.lerian.studio/es/reference/rails/spi/spi/submit-stuck-operation-action).

La pantalla **MED** trata casos de fraude y devolución. Sus pestañas leen el DICT. Cada pestaña lista sus registros y ofrece acciones:

* **Infrações** lee [`GET /api/v1/dict/infractions`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-infractions). **Reconhecer**, **Encerrar** y **Cancelar** llaman a [`POST /api/v1/dict/infractions/{id}/acknowledge`](https://docs.lerian.studio/es/reference/rails/spi/dict/acknowledge-infraction), [`POST /api/v1/dict/infractions/{id}/close`](https://docs.lerian.studio/es/reference/rails/spi/dict/close-infraction) y [`POST /api/v1/dict/infractions/{id}/cancel`](https://docs.lerian.studio/es/reference/rails/spi/dict/cancel-infraction).
* **Devoluções** lee [`GET /api/v1/dict/refunds`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-refunds). **Registrar devolução** llama a [`POST /api/v1/dict/refunds`](https://docs.lerian.studio/es/reference/rails/spi/dict/create-refund). **Analisar** y **Cancelar** llaman a [`POST /api/v1/dict/refunds/{id}/close`](https://docs.lerian.studio/es/reference/rails/spi/dict/close-refund) y [`POST /api/v1/dict/refunds/{id}/cancel`](https://docs.lerian.studio/es/reference/rails/spi/dict/cancel-refund).
* **Marcadores de fraude** lee [`GET /api/v1/dict/fraud-markers`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-fraud-markers). **Registrar marcador** llama a [`POST /api/v1/dict/fraud-markers`](https://docs.lerian.studio/es/reference/rails/spi/dict/create-fraud-marker). **Cancelar** llama a [`POST /api/v1/dict/fraud-markers/{id}/cancel`](https://docs.lerian.studio/es/reference/rails/spi/dict/cancel-fraud-marker).
* **Recuperação de fundos** lee [`GET /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-funds-recoveries). **Abrir recuperação** llama a [`POST /api/v1/dict/funds-recoveries`](https://docs.lerian.studio/es/reference/rails/spi/dict/create-funds-recovery). En el detalle, **Cancelar recuperação** llama a [`POST /api/v1/dict/funds-recoveries/{id}/cancel`](https://docs.lerian.studio/es/reference/rails/spi/dict/cancel-funds-recovery), y **Solicitar devolução** llama a [`POST /api/v1/dict/funds-recoveries/{id}/refund`](https://docs.lerian.studio/es/reference/rails/spi/dict/create-funds-recovery-refund).

## Red

***

La pantalla **Participantes**, con el título **Participantes indiretos**, lista los participantes indirectos. Lee [`GET /api/v1/core/participants/`](https://docs.lerian.studio/es/reference/rails/spi/core/list-participants).

* **Credenciar** acredita a un participante con [`POST /api/v1/core/participants/`](https://docs.lerian.studio/es/reference/rails/spi/core/register-participant).
* **Contatos** envía los contactos con [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/es/reference/rails/spi/spi/register-responsibles). **Contato MED** llama a [`PUT /api/v1/core/participants/{ispb}/contact`](https://docs.lerian.studio/es/reference/rails/spi/core/update-participant-contact).
* **Descredenciar**, **Suspender** y **Reativar** llaman a [`POST /api/v1/core/participants/{ispb}/offboard`](https://docs.lerian.studio/es/reference/rails/spi/core/offboard-participant), [`POST /api/v1/core/participants/{ispb}/suspend`](https://docs.lerian.studio/es/reference/rails/spi/core/suspend-participant) y [`POST /api/v1/core/participants/{ispb}/activate`](https://docs.lerian.studio/es/reference/rails/spi/core/activate-participant).
* **Confirmar encerramento** en la alarma de portabilidad llama a la operación de descredenciamiento.

La pantalla **Responsáveis**, con el título **Responsáveis Conta PI**, muestra los responsables registrados. Lee [`GET /api/v1/spi/responsibles`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-responsibles). **Registrar** o **Editar** envía los contactos con [`POST /api/v1/spi/responsibles`](https://docs.lerian.studio/es/reference/rails/spi/spi/register-responsibles).

La pantalla **DICT**, con el título **Chaves DICT**, lista las claves Pix. Lee [`GET /api/v1/dict/keys`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-keys), [`GET /api/v1/dict/keys/search`](https://docs.lerian.studio/es/reference/rails/spi/dict/search-keys) y [`GET /api/v1/dict/keys/stats`](https://docs.lerian.studio/es/reference/rails/spi/dict/key-stats).

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

La pantalla **Reivindicações** lista las reivindicaciones. Lee [`GET /api/v1/dict/claims`](https://docs.lerian.studio/es/reference/rails/spi/dict/list-claims). Las vistas son **Todas**, **Enviadas** y **Recebidas**. **Iniciar reivindicação** llama a [`POST /api/v1/dict/participants/{participantISPB}/claims`](https://docs.lerian.studio/es/reference/rails/spi/dict/initiate-claim).

La pantalla **Detalhe da reivindicação** lee [`GET /api/v1/dict/claims/{claimID}`](https://docs.lerian.studio/es/reference/rails/spi/dict/get-claim). Ofrece las decisiones que se aplican a la reivindicación para la institución. Cada decisión llama a una operación:

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

## Productos

***

La pantalla **Pix Automático** es de solo lectura. **Mandatos** lee [`GET /api/v1/spi/mandates`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-mandates) y [`GET /api/v1/spi/mandates/{mandateId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-mandate). **Agendamentos** lee [`GET /api/v1/spi/scheduled-payments`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-schedules) y [`GET /api/v1/spi/scheduled-payments/{scheduleId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-schedule).

La pantalla **BR Code** tiene ocho vistas. Cada vista lee sus registros, y algunas vistas los crean o los cambian.

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

## Mensajes

***

La pantalla **Mensagens** lista los mensajes del SPI. Lee [`GET /api/v1/spi/messages`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-message-log), y **Detalhe da mensagem** lee [`GET /api/v1/spi/messages/{messageRecordId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-message-log-detail). Puedes usar **Exportar CSV**. **Testar conectividade** llama a [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/es/reference/rails/spi/spi/create-connectivity-test).

La pantalla **Nova mensagem** envía un mensaje. Su lista ofrece estos tipos:

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

## Evidencias

***

* **Consulta** encuentra los mensajes de una transacción por su clave de negocio. Lee [`GET /api/v1/spi/messages`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-message-log).
* **Relatórios** genera un informe para un período, con **Gerar relatório**. Los informes son **Volumetria PIX**, **Transações rejeitadas**, **DICT · chaves**, **DICT · reivindicações**, **Conta PI · saldos** y **Conta PI · extratos**. Leen [`GET /api/v1/spi/reports/volumetria`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-spi-report-volumetria), [`GET /api/v1/spi/reports/rejected`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-spi-report-rejected), [`GET /api/v1/dict/reports/keys-summary`](https://docs.lerian.studio/es/reference/rails/spi/dict/get-dict-report-keys-summary), [`GET /api/v1/dict/reports/claims-summary`](https://docs.lerian.studio/es/reference/rails/spi/dict/get-dict-report-claims-summary), [`GET /api/v1/spi/reports/balances`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-spi-report-balances) y [`GET /api/v1/spi/reports/extracts`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-spi-report-extracts).
* **Catálogo**, con el título **Capacidades**, lista las capacidades del riel con [`GET /api/v1/spi/capabilities`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-spi-capabilities). Una capacidad abre [`GET /api/v1/spi/capabilities/{capabilityId}`](https://docs.lerian.studio/es/reference/rails/spi/spi/get-spi-capability).

## Configuración

***

La pantalla **Configuração** tiene dos secciones. **Certificados** lista los certificados Pix, leídos con [`GET /api/v1/spi/certificates`](https://docs.lerian.studio/es/reference/rails/spi/spi/list-pix-certificates). **Limiares** guarda los umbrales operativos (consulta [Configuración de Lerian Cabine](https://docs.lerian.studio/es/rails/cabine/cabine-configuration.md)). **Testar conectividade** llama a [`POST /api/v1/spi/connectivity-tests`](https://docs.lerian.studio/es/reference/rails/spi/spi/create-connectivity-test).

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

## Relacionados

***

* [Cómo funciona Lerian SPI](https://docs.lerian.studio/es/rails/spi/how-spi-works.md)
* [Acceso y roles en Lerian Cabine](https://docs.lerian.studio/es/rails/cabine/cabine-access-and-roles.md)


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