Skip to main content
O Lerian Consignado combina comandos HTTP síncronos com fatos assíncronos e leituras agendadas da Dataprev. A API HTTP admite trabalho e responde a consultas. O outbox publica fatos de negócio. Os workers em segundo plano descobrem ou recuperam o estado que a Dataprev expõe como feeds, em vez de callbacks.

1. Configure um tenant

Antes de um tenant poder chamar o trilho, registre:
  • um certificado de cliente ICP-Brasil A1 e uma chave privada
  • credenciais de cliente OAuth2
  • o código solicitante de três dígitos da Dataprev do tenant
  • a URL base do portal do trabalhador usada nas propostas de lance
O status das credenciais retorna presença, impressão digital do certificado e metadados de expiração. Ele nunca retorna o certificado, a chave privada ou o segredo OAuth.

2. Consulte os dados e a margem do trabalhador

O endpoint de margem autentica o tenant, obtém o contexto de autorização da Dataprev do trabalhador e retorna a resposta do trilho sem transformá-la em uma decisão de análise de risco. A API também expõe novos vínculos empregatícios, relatórios de desligamento, registros de FGTS autorizados e leituras de saldo de FGTS.

3. Descubra leilões e envie propostas

Um ciclo de descoberta agendado lista solicitações de empréstimo abertas. Você pode então enviar um lance pela API HTTP autenticada. O gateway retém a carga útil durável do lance necessária para provar o que você enviou e, posteriormente, publica a testemunha de proposta aceita. Os leilões de portabilidade usam uma operação de resposta separada e uma janela limitada de requisição à Dataprev.

4. Registre e financie o contrato

O fluxo de registro:
  1. registra o contrato na Dataprev
  2. anexa o documento CCB quando necessário
  3. expõe o status de registro e os documentos do trilho
  4. registra a confirmação de desembolso do cliente
  5. publica fatos imutáveis de registro e pagamento por meio do outbox
Um credor ou ledger a jusante decide o que esses fatos significam para seus próprios livros. O gateway não lança diretamente no ledger.

5. Administre o contrato

A API cobre o ciclo de vida do trilho após o registro: suspensão, reativação, alterações de prazo, antecipação e reversão de parcelas, exclusão, refinanciamento e reversão, renegociação, registro de portabilidade e operações de contratos legados. A exclusão é uma operação recuperável. O comando autenticado inicial registra a intenção, e um ciclo de recuperação agendado conduz o trabalho admitido a um estado terminal no trilho. Repetir o mesmo comando idempotente não cria uma segunda exclusão.

6. Concilie a folha e os repasses

O worker de conciliação lê duas fontes independentes da Dataprev:
  • registros de escrituração, identificados pela competência de folha e pelo contexto do contrato
  • registros de repasse da CEF, que representam o movimento de liquidação
O gateway emite um fato de conciliação por registro de fonte e acompanha os repasses esperados. Um repasse pode ficar em atraso, ser resolvido mais tarde ou se tornar não observável quando o gateway não consegue estabelecer uma visão atual do trilho. Os consumidores não devem tratar o silêncio como liquidação.

7. Opere carteiras e garantias

Famílias adicionais de API abrangem calendários operacionais, desligamentos empregatícios, execução de garantias de FGTS, fundos, créditos cedidos, cessões, throughput por tenant, uso e assinaturas de entrega de eventos.
A referência da API é gerada a partir do contrato de develop do produto. Use a página da operação para obter os cabeçalhos obrigatórios exatos, regras de idempotência, intervalos de validação e esquemas de resposta.