SPI in Cabine - Lerian

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, GET /api/v1/spi/operations/stuck and GET /api/v1/dict/claims. Abrir pagamentos opens the payments list.

Money

The Pagamentos screen lists Pix payments. It reads GET /api/v1/spi/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} and GET /api/v1/spi/payments/{endToEndID}/history. Its tabs Eventos, Linha do tempo and Evidências read GET /api/v1/spi/operations/{operationId}/timeline and GET /api/v1/spi/operations/{operationId}/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.
Exportar evidência builds an artifact from the recorded evidence. It calls POST /api/v1/spi/evidence/exports and follows the export with GET /api/v1/spi/evidence/exports/{exportId}.

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 and reads them with GET /api/v1/spi/account-reports/{correlationId}/balance and GET /api/v1/spi/account-reports/{correlationId}/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, 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. 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}.

Solicitar aprovação asks for an approval that another operator decides. It calls POST /api/v1/spi/approvals.
Aprovar and Negar decide an approval. They call POST /api/v1/spi/approvals/{approvalId}/decision. 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. The rail decides which actions each row offers.

Resolver manualmente calls POST /api/v1/spi/operations/{operationId}/recovery/manual-resolution. 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.

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. Reconhecer, Encerrar and Cancelar call POST /api/v1/dict/infractions/{id}/acknowledge, POST /api/v1/dict/infractions/{id}/close and POST /api/v1/dict/infractions/{id}/cancel.
Devoluções reads GET /api/v1/dict/refunds. Registrar devolução calls POST /api/v1/dict/refunds. Analisar and Cancelar call POST /api/v1/dict/refunds/{id}/close and POST /api/v1/dict/refunds/{id}/cancel.
Marcadores de fraude reads GET /api/v1/dict/fraud-markers. Registrar marcador calls POST /api/v1/dict/fraud-markers. Cancelar calls POST /api/v1/dict/fraud-markers/{id}/cancel.
Recuperação de fundos reads GET /api/v1/dict/funds-recoveries. Abrir recuperação calls POST /api/v1/dict/funds-recoveries. In the detail, Cancelar recuperação calls POST /api/v1/dict/funds-recoveries/{id}/cancel, and Solicitar devolução calls POST /api/v1/dict/funds-recoveries/{id}/refund.

Network

The Participantes screen, titled Participantes indiretos, lists the indirect participants. It reads GET /api/v1/core/participants/.

Credenciar enrolls a participant with POST /api/v1/core/participants/.
Contatos sends the contacts with POST /api/v1/spi/responsibles. Contato MED calls PUT /api/v1/core/participants/{ispb}/contact.
Descredenciar, Suspender and Reativar call POST /api/v1/core/participants/{ispb}/offboard, POST /api/v1/core/participants/{ispb}/suspend and POST /api/v1/core/participants/{ispb}/activate.
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. Registrar or Editar sends the contacts with POST /api/v1/spi/responsibles. The DICT screen, titled Chaves DICT, lists Pix keys. It reads GET /api/v1/dict/keys, GET /api/v1/dict/keys/search and GET /api/v1/dict/keys/stats.

Registrar chave calls POST /api/v1/dict/keys.
Consultar chave calls POST /api/v1/dict/keys/lookup. Verificar em lote calls POST /api/v1/dict/keys/check.
Editar calls PUT /api/v1/dict/keys/{key}. Excluir calls DELETE /api/v1/dict/keys.

The Reivindicações screen lists the claims. It reads GET /api/v1/dict/claims. The views are Todas, Enviadas and Recebidas. Iniciar reivindicação calls POST /api/v1/dict/participants/{participantISPB}/claims. The Detalhe da reivindicação screen reads GET /api/v1/dict/claims/{claimID}. 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.
Confirmar calls POST /api/v1/dict/claims/{claimID}/confirm.
Rejeitar calls POST /api/v1/dict/claims/{claimID}/reject.
Cancelar calls POST /api/v1/dict/claims/{claimID}/cancel.
Concluir calls POST /api/v1/dict/claims/{claimID}/complete.

Products

The Pix Automático screen is read-only. Mandatos reads GET /api/v1/spi/mandates and GET /api/v1/spi/mandates/{mandateId}. Agendamentos reads GET /api/v1/spi/scheduled-payments and GET /api/v1/spi/scheduled-payments/{scheduleId}. 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`, `GET /api/v1/brcode/cob/{txid}`	`POST /api/v1/brcode/cob`, `PUT /api/v1/brcode/cob/{txid}`, `PATCH /api/v1/brcode/cob/{txid}`
Cobranças com vencimento	`GET /api/v1/brcode/cobv`, `GET /api/v1/brcode/cobv/{txid}`	`PUT /api/v1/brcode/cobv/{txid}`, `PATCH /api/v1/brcode/cobv/{txid}`
Cobranças recorrentes	`GET /api/v1/brcode/cobr`, `GET /api/v1/brcode/cobr/{txid}`	`POST /api/v1/brcode/cobr`, `PUT /api/v1/brcode/cobr/{txid}`, `PATCH /api/v1/brcode/cobr/{txid}`, `POST /api/v1/brcode/cobr/{txid}/retentativa/{data}`
Recorrências	`GET /api/v1/brcode/rec`, `GET /api/v1/brcode/rec/{idRec}`	`POST /api/v1/brcode/rec`, `PATCH /api/v1/brcode/rec/{idRec}`
Solicitações de confirmação	`GET /api/v1/brcode/solicrec/{idSolicRec}`	`POST /api/v1/brcode/solicrec`, `PATCH /api/v1/brcode/solicrec/{idSolicRec}`
Locations de payload	`GET /api/v1/brcode/loc`, `GET /api/v1/brcode/loc/{id}`	`POST /api/v1/brcode/loc`, `DELETE /api/v1/brcode/loc/{id}/txid`
Locations de recorrência	`GET /api/v1/brcode/locrec`, `GET /api/v1/brcode/locrec/{id}`	`POST /api/v1/brcode/locrec`, `DELETE /api/v1/brcode/locrec/{id}/idRec`
Lotes de cobrança	`GET /api/v1/brcode/lotecobv`, `GET /api/v1/brcode/lotecobv/{id}`	`PUT /api/v1/brcode/lotecobv/{id}`

Messages

The Mensagens screen lists SPI messages. It reads GET /api/v1/spi/messages, and Detalhe da mensagem reads GET /api/v1/spi/messages/{messageRecordId}. You can use Exportar CSV. Testar conectividade calls POST /api/v1/spi/connectivity-tests. 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`
Devolver pagamento (`pacs.004`)	`POST /api/v1/spi/payments/{endToEndID}/returns`
Cancelar recorrência (`pain.011`)	`POST /api/v1/spi/mandates/cancellations`
Informar status da cobrança (`pain.014`)	`POST /api/v1/spi/scheduled-payments/resolutions`
Reportar rastreio (`trck.002`)	`POST /api/v1/spi/settlement-reports`
Resolver cancelamento (`camt.029`)	`POST /api/v1/spi/scheduled-payments/cancellations/resolutions`
Solicitar cancelamento (`camt.055`)	`POST /api/v1/spi/scheduled-payments/cancellations`
Testar conectividade (`pibr.001`)	`POST /api/v1/spi/connectivity-tests`
Credenciar liquidante (`reda.014`)	`POST /api/v1/core/participants/`
Atualizar responsáveis (`reda.022`)	`POST /api/v1/spi/responsibles`
Descredenciar liquidante (`reda.031`)	`POST /api/v1/core/participants/{ispb}/offboard`

Evidence

Consulta finds the messages of one transaction by its business key. It reads GET /api/v1/spi/messages.
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, GET /api/v1/spi/reports/rejected, GET /api/v1/dict/reports/keys-summary, GET /api/v1/dict/reports/claims-summary, GET /api/v1/spi/reports/balances and GET /api/v1/spi/reports/extracts.
Catálogo, titled Capacidades, lists the capabilities of the rail with GET /api/v1/spi/capabilities. One capability opens GET /api/v1/spi/capabilities/{capabilityId}.

Configuration

The Configuração screen has two sections. Certificados lists the Pix certificates, read with GET /api/v1/spi/certificates. Limiares holds the operating thresholds (see Configuring Lerian Cabine). Testar conectividade calls POST /api/v1/spi/connectivity-tests.

Importar certificado calls POST /api/v1/spi/certificates. A certificate opens GET /api/v1/spi/certificates/{id}.
Desativar calls DELETE /api/v1/spi/certificates/{id}.

​Overview

​Money

​Cases

​Network

​Products

​Messages

​Evidence

​Configuration

​Related