Consulta de Escrituração e Repasse

Este documento apresenta os exemplos de requisição e resposta para Consultar Escriturações e para Consultar Repasses, no contexto da integração entre instituições financeiras e o sistema do eSocial.

1. Consulta de Escrituração

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 poderá consultar todos os eventos recebidos. Para isso, é necessário informar um intervalo de tempo e o número da página desejada. Como retorno, serão exibidas as informações da página solicitada, além de uma lista de elementos de escrituração contendo dados como contato, período de referência e valor da parcela.

Show Exemplo de Requisição

curl --location --request GET 'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-escrituracoes?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \
--header 'Authorization: Bearer <token>'

Show Exemplo de Resposta

{
  "CodigoRequisicao": "7b307672-a414-4b8b-9bb6-e38482581765",
  "Origem": "/consultar-escrituracoes",
  "Conteudo": {
    "nroPaginaAtual": 1,
    "nroTotalPaginas": 3,
    "nroTotalRegistros": 105,
    "qtdRegistrosPorPagina": 50,
    "qtdRegistrosPaginaAtual": 50,
    "dataHoraInicio": "ddMMyyyyHHmmss",
    "dataHoraFim": "ddMMyyyyHHmmss",
    "conteudo": [
      {
        "id": 123,
        "idEvento": "string",
        "periodoReferencia": 202505,
        "codigoIF": 999,
        "contrato": "string",
        "valorParcelaDesconto": 0,
        "cpf": 0,
        "inscricaoEmpregador": {
          "codigo": 0,
          "descricao": "string"
        },
        "numeroInscricaoEmpregador": 0,
        "matricula": "string",
        "dataHoraInclusaoDataprev": "ddMMyyyyHHmmss",
        "idEventoExclusao": 0,
        "dataHoraEventoExclusao": "ddMMyyyyHHmmss",
        "idEventoRetificacao": 0,
        "dataHoraEventoRetificacao": "ddMMyyyyHHmmss",
        "emprestimo": {
          "codigoIf": 0,
          "contrato": "string",
          "valorParcela": 0
        },
        "analise": {
          "existeTrabalhadorEscriturado": true,
          "existeNumeroContratoEscriturado": true,
          "vinculoCorreto": true,
          "instituicaoFinanceiraCorreta": true,
          "valorParcelaCorreta": true,
          "dadosCorrespondentes": true
        }
      }
    ]
  },
  "Erros": []
}

2. Consulta de Repasse

Síncrona Através da operação supracitada, a instituição financeira poderá conferir seus repasses feitos pela Caixa, em um intervalo de tempo. Para isso, basta informar o intervalo desejado e o número da página que se quer consultar. Como retorno, serão apresentadas as informações da página solicitada, além de uma lista paginada contendo dados como: guias já pagas dentro do intervalo informado, número do contrato, valor da parcela paga, data e hora do pagamento da guia, data de inclusão no sistema da DATAPREV, data do repasse à instituição financeira e número da guia.

Show Exemplo de Requisição

curl --location --request GET'https://econsignadotrabalhador.moneyp.dev.br/contrato/consultar-repasses?dataHoraInicio=01082025000000&dataHoraFim=14082025000000&nropagina=1' \
--header 'Authorization: Bearer <token>'

Show Exemplo de Resposta

{
  "CodigoRequisicao": "7b307672-a414-4b8b-9bb6-e38482581765",
  "Origem": "/consultar-repasses",
  "Conteudo": {
    "NroPaginaAtual": 1,
    "NroTotalPaginas": 1,
    "NroTotalRegistros": 10,
    "QtdRegistrosPorPagina": 250,
    "QtdRegistrosPaginaAtual": 10,
    "DataHoraInicio": "01082025000000",
    "DataHoraFim": "14082025000000",
    "Conteudo": [
      {
        "Id": 4146,
        "CodigoIF": 531,
        "Contrato": "5094853",
        "ValorParcelaPaga": 600,
        "DataHoraPagamentoGuia": "11082025000000",
        "DataHoraInclusaoDataprev": "13082025110600",
        "DataHoraRepasseIF": "12082025000000",
        "NumeroGuia": 1755093960
      }
    ]
  },
  "Erros": []
}

Endpoints e Documentos Auxiliares

Para esta jornada, é muito importante que o parceiro conheça o Procedimento Técnico de Callbacks do E-Consignado Trabalhador e tenha uma URL de callbacks configurada. Também podem ser úteis os seguintes endpoints do CaaS:

28 - Consultar Contrato: utilizado nesta jornada para consultar os dados da proposta;
38 - Consultar Comprovante de Pagamento: utilizado nesta jornada para consultar o comprovante de pagamento da proposta;
44 - Atualização da Conta Bancária: utilizado nesta jornada para atualização da conta pagamento;
11 - Cancelar Contrato: utilizado nesta jornada para cancelar contratos.

Guia Inicial

Métodos de Assinatura

Guia do Desenvolvedor

Referências de API

Casos de Uso

Consulta de Escrituração e Repasse

1. Consulta de Escrituração

2. Consulta de Repasse

Endpoints e Documentos Auxiliares

Guia Inicial

Métodos de Assinatura

Guia do Desenvolvedor

Referências de API

Casos de Uso

​1. Consulta de Escrituração

​2. Consulta de Repasse

​Endpoints e Documentos Auxiliares

1. Consulta de Escrituração

2. Consulta de Repasse

Endpoints e Documentos Auxiliares