Desaverbação de Contratos
Visão Geral
Esta API permite que o originador solicite a desaverbaçãode operações de crédito consignado já desembolsadas, mantendo a CCB ativa e registrada. A rota possibilita que o originador interrompa a averbação junto ao órgão correspondente, sempre que necessário, garantindo alinhamento entre o status operacional da operação e o registro do órgão de consignação.
A desaverbação é solicitada pelo ID da operação, mediante envio do motivo da solicitação, e somente para operações que atendam aos critérios de elegibilidade, incluindo o prazo mínimo de 7 dias após o desembolso e a vinculação da operação ao próprio originador.
A solicitação de desaverbação é irreversível; após concluída, não é possível restabelecer a averbação
Endpoint
POST /originator/applications/{id}/remove/guaranteeExemplo de Requisição
curl --location --request POST 'https://platform.flowfinance.com.br/banking/originator/applications/556ed234-cac2-4821-8845-b165c12a9965/remove/guarantee?reason=Teste' \
--header 'Authorization: Bearer *'Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reason | string | Sim | Motivo do cancelamento da garantia |
Response
Na requisição será retornado 202 e posteriormente enviado o resultado via Webhook previamente cadastrado:
{
"event": "consigned_unassignment.result",
"contract": "{\"id\":\"ca973309-74ff-4ea4-b213-97e9aa3752e3\",\"status\":\"SUCCESS\",\"contract_number\":\"180775\",\"processed_at\":\"2025-11-25T16:43:16Z\"}",
}Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | Identificador operação relacionada ao evento de desaverbação. |
| status | string | Status do processamento da desaverbação (ex.: SUCCESS, FAILED). |
| contract_number | string | Número da CCB |
| processed_at | datetime / timestamp (ISO 8601) | Data e hora em que a operação foi processada. Use formato ISO 8601 (ex.: 2025-11-25T16:43:16Z). |
Possíveis Erros
| Situação | Código HTTP | Exemplo de Resposta |
|---|---|---|
| Operação com menos de 7 dias desde o desembolso | 400 | Operação não elegível para desaverbação. Aguarde o prazo mínimo de 7 dias após o desembolso. |
| Operação não é de consignado (CT, FGTS ou Siape) | 400 | Operação não elegível para desaverbação |
| O status da operação deve ser "emitida" | 400 | O status da operação não é antes da garantia |
| Operação já desaverbada anteriormente | 400 | Não existem garantias para serem canceladas |
Campo reason ausente | 400 | Campo reason é obrigatório` |
| Operação não pertence ao originador | 403 | Você não tem permissão para alterar esta operação. |
| Falha ao processar solicitação | 500 | Erro ao processar solicitação. |
| Órgão indisponível (API do órgão fora do ar ou manutenção) | 503 | Serviço do órgão temporariamente indisponível. Tente novamente mais tarde. |
Updated 3 days ago