Cancelar Cobrança de Parcela(s)
Tipo: Síncrona Este serviço é utilizado para cancelar uma cobrança previamente gerada para uma ou mais parcelas de um contrato de E-Consignado Trabalhador. O cancelamento deve ser acionado quando a cobrança não deve mais ser considerada válida, como nos seguintes cenários:- Renegociação do contrato;
- Erro na geração da cobrança;
- Pagamento realizado por outro meio;
- Ajustes operacionais antes da liquidação.
Endpoint
POST/contrato/parcela/cancelar-cobranca
Pré-requisitos
- Contrato previamente existente na BMP;
-
Cobrança previamente gerada (com
codigoLiquidacao); - Token de autenticação válido.
Parâmetros da Requisição
| Campo | Obrigatório | Descrição |
|---|---|---|
NumeroContrato | Sim | Número do contrato (CCB) vinculado à cobrança. |
CodigosLiquidacoes | Sim | Lista de identificadores (codigoLiquidacao) das cobranças a serem canceladas. |
Exemplo de Requisição
curl --location --request POST 'https://econsignadotrabalhador.moneyp.dev.br/contrato/parcela/cancelar-cobranca' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "NumeroContrato": 5075328, "CodigosLiquidacoes": [ "f70e58c7-0eca-451a-a725-28ba4c0ad51c" ] }'
Exemplo de Retorno
{ "CodigoRequisicao": "3d005ff5-c448-4859-a191-8ab22cc73f99", "Origem": "CancelarCobranca", "Conteudo": { "Mensagem": "Cancelamento solicitado" }, "Erros": [] }
Comportamento Esperado
Após o envio da requisição:- A cobrança informada é marcada para cancelamento;
- A cobrança deixa de ser considerada válida para pagamento;
- O contrato permanece ativo, sem impacto direto em outras parcelas;
- O cancelamento não implica quitação automática de parcelas.
Considerações Técnicas
- O cancelamento não altera o histórico financeiro do contrato;
- Apenas cobranças previamente geradas podem ser canceladas;
- Caso a cobrança já tenha sido liquidada, o cancelamento poderá ser rejeitado;
- Para verificar o status atualizado das parcelas, utilize o endpoint de consulta de detalhes de parcelas.