Pular para o conteúdo principal

Regularização e Antecipação de Parcelas

Este conjunto de serviços permite consultar, calcular, cobrar e regularizar parcelas de contratos de E-Consignado Trabalhador, incluindo parcelas em atraso, antecipadas ou abertas, com cálculo atualizado para a data informada.
  1. Consultar Situação das Parcelas

Tipo: Síncrona Este serviço permite consultar os detalhes completos do contrato e de suas parcelas, incluindo situação, valores pagos, saldo em aberto e instrumentos de cobrança associados (boleto e PIX).

Endpoint

POST /contrato/parcela/consultar-detalhes

Pré-requisitos

  • Contrato previamente existente na BMP;
  • Token de autenticação válido.

Parâmetros da Requisição

CampoObrigatórioDescrição
numeroContratoSimNúmero do contrato (CCB) do empréstimo.

Exemplo de Requisição

curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/parcela/consultar-detalhes' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "numeroContrato": 5075328 }'

Exemplo de Retorno

O retorno apresenta:
  • Dados gerais do contrato;
  • Situação de cada parcela;
  • Valores pagos, saldo atualizado;
  • Instrumentos de cobrança (boletos, PIX);
  • Histórico de lançamentos financeiros.
(Exemplo completo conforme retorno técnico da API) pasted

Comportamento Esperado

  • Retornar todas as parcelas vinculadas ao contrato;
  • Identificar parcelas quitadas, abertas ou vencidas;
  • Informar saldo atualizado e histórico de pagamentos.

  1. Consultar Valor Atualizado das Parcelas

Tipo: Síncrona Este serviço realiza o cálculo atualizado das parcelas, considerando:
  • Juros contratuais;
  • Multa e mora;
  • Encargos;
  • Abatimentos por antecipação.

Endpoint

POST /contrato/parcela/consultar

Parâmetros da Requisição

CampoObrigatórioDescrição
numeroContratoSimNúmero do contrato.
NumeroParcelasSimLista das parcelas a serem calculadas.
dataCalculoSimData base do cálculo (ddMMyyyy).
permiteDescapitalizacaoNãoIndica se é permitido cálculo com descapitalização.

Exemplo de Requisição

curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/parcela/consultar' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "numeroContrato": 5075328, "NumeroParcelas": [3,4,5,6,7,8,9], "dataCalculo": "01122025", "permiteDescapitalizacao": true }'

Exemplo de Retorno

O retorno apresenta, para cada parcela:
  • Valor de multa;
  • Valor de mora;
  • Juros contratuais;
  • Encargos;
  • Abatimentos;
  • Saldo atualizado para pagamento.
(Exemplo completo conforme retorno técnico da API) pasted
  1. Gerar Cobrança de Parcela(s)

Tipo: Síncrona Este serviço permite formalizar a cobrança de uma ou mais parcelas, criando registros de cobrança para pagamento via boleto ou PIX.

Endpoint

POST /contrato/parcela/gerar-cobranca

Parâmetros da Requisição

CampoObrigatórioDescrição
NumeroContratoSimNúmero do contrato.
NroParcelasSimLista das parcelas a serem cobradas.
DataVencimentoSimData de vencimento da cobrança.
DataExpiracaoSimData de expiração da cobrança.
LiquidacaoSimIndica se a cobrança é liquidável.
PagamentoViaBoletoSimIndica geração de boleto.
PagamentoViaPIXSimIndica geração de PIX.
DescricaoLiquidacaoNãoDescrição da liquidação.
ValorLiquidacaoNãoValor específico para liquidação.
PermiteDescapitalizacaoNãoPermite cálculo com descapitalização.

Exemplo de Requisição

curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/parcela/gerar-cobranca' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "NumeroContrato": 5075328, "NroParcelas": [3], "DataVencimento": "2025-12-01", "DataExpiracao": "2025-12-01", "Liquidacao": true, "PagamentoViaBoleto": true, "PagamentoViaPIX": false, "DescricaoLiquidacao": "PAGAMENTO", "PermiteDescapitalizacao": true }'

Exemplo de Retorno

{ "CodigoRequisicao": "0be241b2-9508-4679-88ca-d53f5c7420ac", "Origem": "/contrato/parcela/gerar-cobranca", "Conteudo": { "cobrancas": [ { "codigoLiquidacao": "f70e58c7-0eca-451a-a725-28ba4c0ad51c", "parcelas": [3] } ] }, "Erros": [] }

Considerações Técnicas Gerais

  • Todos os cálculos são realizados com base na data informada na requisição;
  • Parcelas podem ser regularizadas individualmente ou em grupo;
  • A geração de cobrança não implica pagamento automático;
  • Acompanhe a liquidação das cobranças por meio da consulta de detalhes das parcelas;
  • Eventuais erros ou rejeições são retornados no objeto Erros.