Suspensão e Reativação de Contratos

Visão Geral

Esta API permite que o originador solicite a suspensão (interrupção temporária da averbação) ou reativação (retorno da averbação ativa) de contratos de consignado após o prazo mínimo de 7 dias do desembolso.

O fluxo foi criado para atender situações operacionais como:

  • Solicitação do tomador para pausa temporária de cobrança;
  • Correções de margem identificadas após o desembolso;
  • Ajustes administrativos solicitados por órgãos de consignação.

Antes desta implementação, não havia uma rota que permitisse registrar e executar essas ações, exigindo intervenção manual da equipe operacional.



Endpoints


Suspensão de Contrato

PUT /originator/guarantee/suspend

Exemplo de Requisição

curl --location --request PUT 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/suspend' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "application_id": "21c80794-2325-4891-91c0-b7e89610c05a",
  "reason": "reason_1de8dd16e803"
}'

Parâmetros

ParâmetroTipoObrigatórioDescrição
application_idstringSimIdentificador único da operação que terá a garantia suspensa.
reasonstringSimMotivo da suspensão da garantia informado pelo originador.

Response

Na requisição será retornado 202 e posteriormente enviado o resultado via Webhook previamente cadastrado.




Reativação de Contrato


PUT /originator/guarantee/reactivate

Exemplo de Requisição

curl --location --request PUT 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/reactivate' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "application_id": "0c471067-e4cf-4072-b84c-65167f511597",
  "reason": "teste"
}'

Parâmetros

ParâmetroTipoObrigatórioDescrição
application_idstringSimIdentificador único da operação que terá a garantia reativada.
reasonstringSimMotivo da reativação da garantia informado pelo originador.

Response

Na requisição será retornado 202 e posteriormente enviado o resultado via Webhook previamente cadastrado.



Webhook de Resultado Final

Desenvolvimento em finalização.



Regras e Validações


RegraDescrição
Operação deve pertencer ao originadorCaso contrário → 403 Forbidden
Mínimo de 7 dias após o desembolsoCaso contrário → 400 Operação não elegível
Campo reason obrigatórioCaso ausente → 400 Campo reason é obrigatório

Possíveis Erros


SituaçãoCódigo HTTPExemplo de Resposta
Operação com menos de 7 dias do desembolso400Operação não elegível para alteração antes de 7 dias do desembolso.
Campo reason ausente400Campo reason é obrigatório`
Operação não é do produto Consignado400Não existem garantias para serem suspensas
Operação não pertence ao originador403Você não tem permissão para alterar esta operação.
Falha ao processar solicitação500Erro ao processar solicitação.
Órgão indisponível (API do órgão fora do ar ou manutenção)503Serviço do órgão temporariamente indisponível. Tente novamente mais tarde.