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/suspendExemplo 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
application_id | string | Sim | Identificador único da operação que terá a garantia suspensa. |
reason | string | Sim | Motivo 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/reactivateExemplo 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
application_id | string | Sim | Identificador único da operação que terá a garantia reativada. |
reason | string | Sim | Motivo 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
| Regra | Descrição |
|---|---|
| Operação deve pertencer ao originador | Caso contrário → 403 Forbidden |
| Mínimo de 7 dias após o desembolso | Caso contrário → 400 Operação não elegível |
| Campo reason obrigatório | Caso ausente → 400 Campo reason é obrigatório |
Possíveis Erros
| Situação | Código HTTP | Exemplo de Resposta |
|---|---|---|
| Operação com menos de 7 dias do desembolso | 400 | Operação não elegível para alteração antes de 7 dias do desembolso. |
Campo reason ausente | 400 | Campo reason é obrigatório` |
| Operação não é do produto Consignado | 400 | Não existem garantias para serem suspensas |
| 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