Skip to main content
Este documento descreve os endpoints disponíveis para consulta de escriturações e consulta de repasses, no contexto da integração entre instituições financeiras, DATAPREV/eSocial e a BMP.
Atualização dos dados:
As APIs são atualizadas diariamente com dados D-1.

1. Consulta de Escrituração


Tipo: Síncrona Após o processamento das folhas de pagamento e a escrituração das informações no eSocial pelo empregador, a instituição financeira pode consultar os eventos escriturados associados aos contratos de consignado. A consulta é realizada por intervalo de datas e paginação. Como retorno, são exibidas as informações da página solicitada, além de uma lista de registros contendo dados como vínculo, período de referência e valor da parcela descontada.

Endpoint

GET /contrato/consultar-escrituracoes

Parâmetros da Requisição (Query Params)



Considerações Técnicas — Escrituração

  • Os dados retornados refletem informações escrituradas no eSocial;
  • Registros podem sofrer exclusões ou retificações, identificadas pelos campos de evento;
  • A análise apresentada indica consistência entre vínculo, contrato e valores informados;
  • Os dados são disponibilizados com defasagem D-1.

2. Consulta de Repasse


Tipo: Síncrona Este endpoint permite à instituição financeira consultar os repasses realizados, normalmente efetuados pela Caixa, dentro de um intervalo de tempo. A consulta retorna informações paginadas contendo, entre outros dados, guias pagas, valor da parcela, datas de pagamento e repasse, e identificação do contrato.

Endpoint

GET /contrato/consultar-repasses

Parâmetros da Requisição (Query Params)



Considerações Técnicas — Repasse

  • Os registros retornados correspondem a parcelas efetivamente pagas;
  • A data de pagamento da guia pode diferir da data de repasse à instituição financeira;
  • Os dados também seguem o critério de atualização D-1;
  • Recomenda-se utilizar este endpoint para conciliação financeira.