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 do motivo (1 = Desistência em até 15 dias, 2 = Falecimento, 3 = Liquidação antecipada, 7 = Ação judicial, 8 = Exclusão por fraude, 9 = Outros). Código fora da tabela retorna 422 ERRO_NEGOCIO. Falha real do upstream retorna 502 com o detalhe em details.upstream.

Parâmetros

idstringpathobrigatório

Corpo da requisição

motivo_cancelamentonumberobrigatório

Código do motivo do cancelamento: `1` = Desistência em até 15 dias, `2` = Falecimento, `3` = Liquidação antecipada, `7` = Ação judicial, `8` = Exclusão por fraude, `9` = Outros. O código é repassado ao consignante (Dataprev), que é a autoridade sobre o domínio — um código fora da tabela retorna `422 ERRO_NEGOCIO` com a mensagem do upstream.

≥ 1

Respostas

Corpo da resposta 200

excluidobooleanobrigatório

numero_contratostringobrigatório

competencia_exclusaostringobrigatório

hash_operacaointegerobrigatório

mensagemstringobrigatório

Request

curl -X POST 'https://econsignado-api.socinal.com.br/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": 3
}'

Response

{
  "excluido": true,
  "numero_contrato": "A000123-001",
  "competencia_exclusao": "202606",
  "hash_operacao": 987654321,
  "mensagem": "Exclusão efetuada com sucesso."
}