Cancelar Operação CLT
Como esta etapa entra no fluxo
Use o cancelamento apenas depois de confirmar que a operação CLT ainda permite cancelamento e que existe motivo operacional para encerrar a contratação.
Antes de cancelar
-
Tenha o idOperation da operação.
-
Confirme o status atual da operação.
-
Informe cancel_reason e, quando necessário, cancel_description.
Este endpoint é utilizado para solicitar o cancelamento de uma operação de Consignação Privada já criada. O cancelamento registra o motivo e, quando aplicável, uma descrição complementar.
Endpoint para cancelar operação de crédito CLT
URL: https://bff.v8sistema.com/private-consignment/operation/{idOperation}/cancel
Método HTTP: POST
Autenticação: Requer token JWT válido no header da requisição.
Exemplo de requisição
{
"cancel_reason": "string",
"cancel_description": "string",
"provider": "QI"
}
Parâmetros da Requisição
-
cancel_reason
string
Motivo do cancelamento podem ser informados conforme os campos abaixo. -
cancel_description
string
Descrição textual do motivo do cancelamento. Envie apenas quandocancel_reason = 'invalid_data:other' -
provider
string
Provedor/originador associado à operação.
Valores:QI.
Não e possivel cancelar um contrato que esteja no status como aguardando pagamento ou pago.
