Cancelar operação

Marca a operação como Canceled, registra a trilha de auditoria, devolve créditos (se ninguém assinou ainda) e notifica os assinantes por email. A operação é atômica: se algo falhar, nada muda e a operação permanece no estado anterior.

Quando usar

• Cliente desistiu antes de todos assinarem
• Operação criada com dados errados (assinante errado, documento errado)
• Mudança no contrato exige nova operação
• Prazo extrapolou e você quer encerrar manualmente em vez de esperar expirar

Endpoint

curl -X POST "https://example.com/api/v2/operation/0/cancel" \  -H "Content-Type: application/json" \  -d '{}'

Body

{
  "message": "Operação cancelada por solicitação do cliente."
}

Exemplo

curl -X POST "https://api.forsign.digital/api/v2/operation/4821/cancel" \
  -H "X-Api-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Operação cancelada por solicitação do cliente." }'

await fetch(`https://api.forsign.digital/api/v2/operation/${operationId}/cancel`, {
  method: 'POST',
  headers: {
    'X-Api-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ message: 'Cliente desistiu.' }),
});

var resp = await http.PostAsJsonAsync(
    $"/api/v2/operation/{operationId}/cancel",
    new { message = "Cliente desistiu." });
resp.EnsureSuccessStatusCode();

Resposta de sucesso (200)

{ "success": true, "statusCode": 200, "messages": [{ "value": "Operação cancelada com sucesso" }] }

Comportamento e gotchas

• O operationId na URL é o ID da operação (o campo id retornado em Criar operação) — o mesmo número usado em todos os endpoints da operação.
• Operações já finalizadas não podem ser canceladas — a chamada retorna 400.
• Devolução de créditos: se nenhum assinante ainda tiver assinado, os créditos de documento são devolvidos. Se houver pelo menos uma assinatura, os créditos não voltam.
• Assinaturas com certificado digital também têm os créditos de certificado devolvidos, quando aplicável.
• O cancelamento fica registrado na trilha de auditoria da operação.
• Um webhook UpdateOperation (status=Canceled) é disparado para os webhooks configurados.
• A notificação por email é assíncrona — se ela falhar, o cancelamento não é revertido.

Erros comuns

Veja também