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, GET /api/v1/spi/operations/stuck e GET /api/v1/dict/claims. Abrir pagamentos abre a lista de pagamentos.
Dinheiro
A tela Pagamentos lista os pagamentos Pix. Ela lê
GET /api/v1/spi/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} e GET /api/v1/spi/payments/{endToEndID}/history. As abas Eventos, Linha do tempo e Evidências leem GET /api/v1/spi/operations/{operationId}/timeline e GET /api/v1/spi/operations/{operationId}/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. - Exportar evidência gera um artefato com a evidência registrada. Ela chama
POST /api/v1/spi/evidence/exportse acompanha a exportação comGET /api/v1/spi/evidence/exports/{exportId}.
POST /api/v1/spi/account-reports/requests e os lê com GET /api/v1/spi/account-reports/{correlationId}/balance e GET /api/v1/spi/account-reports/{correlationId}/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, uma operação do Lerian SPB.
POST /api/v1/spi/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}.
- Solicitar aprovação pede uma aprovação que outro operador decide. Ela chama
POST /api/v1/spi/approvals. - Aprovar e Negar decidem uma aprovação. Elas chamam
POST /api/v1/spi/approvals/{approvalId}/decision. O trilho recusa a decisão de quem solicitou a aprovação.
GET /api/v1/spi/operations/stuck. O trilho decide quais ações cada linha oferece.
- Resolver manualmente chama
POST /api/v1/spi/operations/{operationId}/recovery/manual-resolution. 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.
- Infrações lê
GET /api/v1/dict/infractions. Reconhecer, Encerrar e Cancelar chamamPOST /api/v1/dict/infractions/{id}/acknowledge,POST /api/v1/dict/infractions/{id}/closeePOST /api/v1/dict/infractions/{id}/cancel. - Devoluções lê
GET /api/v1/dict/refunds. Registrar devolução chamaPOST /api/v1/dict/refunds. Analisar e Cancelar chamamPOST /api/v1/dict/refunds/{id}/closeePOST /api/v1/dict/refunds/{id}/cancel. - Marcadores de fraude lê
GET /api/v1/dict/fraud-markers. Registrar marcador chamaPOST /api/v1/dict/fraud-markers. Cancelar chamaPOST /api/v1/dict/fraud-markers/{id}/cancel. - Recuperação de fundos lê
GET /api/v1/dict/funds-recoveries. Abrir recuperação chamaPOST /api/v1/dict/funds-recoveries. No detalhe, Cancelar recuperação chamaPOST /api/v1/dict/funds-recoveries/{id}/cancel, e Solicitar devolução chamaPOST /api/v1/dict/funds-recoveries/{id}/refund.
Rede
A tela Participantes, com o título Participantes indiretos, lista os participantes indiretos. Ela lê
GET /api/v1/core/participants/.
- Credenciar credencia um participante com
POST /api/v1/core/participants/. - Contatos envia os contatos com
POST /api/v1/spi/responsibles. Contato MED chamaPUT /api/v1/core/participants/{ispb}/contact. - Descredenciar, Suspender e Reativar chamam
POST /api/v1/core/participants/{ispb}/offboard,POST /api/v1/core/participants/{ispb}/suspendePOST /api/v1/core/participants/{ispb}/activate. - Confirmar encerramento no alarme de portabilidade chama a operação de descredenciamento.
GET /api/v1/spi/responsibles. Registrar ou Editar envia os contatos com POST /api/v1/spi/responsibles.
A tela DICT, com o título Chaves DICT, lista as chaves Pix. Ela lê GET /api/v1/dict/keys, GET /api/v1/dict/keys/search e GET /api/v1/dict/keys/stats.
- Registrar chave chama
POST /api/v1/dict/keys. - Consultar chave chama
POST /api/v1/dict/keys/lookup. Verificar em lote chamaPOST /api/v1/dict/keys/check. - Editar chama
PUT /api/v1/dict/keys/{key}. Excluir chamaDELETE /api/v1/dict/keys.
GET /api/v1/dict/claims. As visões são Todas, Enviadas e Recebidas. Iniciar reivindicação chama POST /api/v1/dict/participants/{participantISPB}/claims.
A tela Detalhe da reivindicação lê GET /api/v1/dict/claims/{claimID}. 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. - Confirmar chama
POST /api/v1/dict/claims/{claimID}/confirm. - Rejeitar chama
POST /api/v1/dict/claims/{claimID}/reject. - Cancelar chama
POST /api/v1/dict/claims/{claimID}/cancel. - Concluir chama
POST /api/v1/dict/claims/{claimID}/complete.
Produtos
A tela Pix Automático é somente de leitura. Mandatos lê
GET /api/v1/spi/mandates e GET /api/v1/spi/mandates/{mandateId}. Agendamentos lê GET /api/v1/spi/scheduled-payments e GET /api/v1/spi/scheduled-payments/{scheduleId}.
A tela BR Code tem oito visões. Cada visão lê seus registros, e algumas visões os criam ou alteram.
Mensagens
A tela Mensagens lista as mensagens do SPI. Ela lê
GET /api/v1/spi/messages, e Detalhe da mensagem lê GET /api/v1/spi/messages/{messageRecordId}. Você pode usar Exportar CSV. Testar conectividade chama POST /api/v1/spi/connectivity-tests.
A tela Nova mensagem envia uma mensagem. Sua lista oferece estes tipos:
Evidências
- Consulta encontra as mensagens de uma transação pela chave de negócio. Ela lê
GET /api/v1/spi/messages. - 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,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/balanceseGET /api/v1/spi/reports/extracts. - Catálogo, com o título Capacidades, lista as capacidades do trilho com
GET /api/v1/spi/capabilities. Uma capacidade abreGET /api/v1/spi/capabilities/{capabilityId}.
Configuração
A tela Configuração tem duas seções. Certificados lista os certificados Pix, lidos com
GET /api/v1/spi/certificates. Limiares guarda os limiares operacionais (veja Configurando o Lerian Cabine). Testar conectividade chama POST /api/v1/spi/connectivity-tests.
- Importar certificado chama
POST /api/v1/spi/certificates. Um certificado abreGET /api/v1/spi/certificates/{id}. - Desativar chama
DELETE /api/v1/spi/certificates/{id}.

