Cancelar CCB

POST/v1/emprestimos/{id}/cancelamento

🔒 Requer Bearer token

Escopo emprestimos:write. Requer header Idempotency-Key. Cancela a averbação do empréstimo junto à Socinal/Dataprev e marca o empréstimo como cancelada. Só é possível para empréstimos averbada, desembolsada ou em_atraso (409 caso contrário). motivo_cancelamento é o código aceito pelo upstream. Falha real do upstream retorna 502 com o detalhe em details.upstream.

Parâmetros

idstringpathobrigatório

Corpo da requisição

motivo_cancelamentonumberobrigatório

≥ 1

Respostas

200Consignado excluído (status `cancelada`).

400Header `Idempotency-Key` ausente (`IDEMPOTENCY_KEY_OBRIGATORIA`). Dados inválidos (`ERRO_VALIDACAO`).

401Token ausente ou inválido (`CREDENCIAL_INVALIDA`).

404Empréstimo inexistente (`EMPRESTIMO_NAO_ENCONTRADO`).

422Regra de negócio impede a operação (`ERRO_NEGOCIO`). A mensagem traz o motivo (inclusive de sistemas a montante, como o BaaS Socinal).

502Integração externa indisponível (`DATAPREV_INDISPONIVEL`).

Request

curl -X POST 'http://localhost:3101/v1/emprestimos/:id/cancelamento' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Idempotency-Key: 3f1c8a90-0000-4000-8000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo_cancelamento": 0
}'

Response

{
  "excluido": true,
  "competenciaExclusao": "2026-06"
}