Skip to content
Documentação IntegraDoor

Cancelamento

Caso de Uso

  1. Cancelar uma autorização utilizando o guiaId

    Utilize o endpoint: POST /api/v2/autorizar/autorizacoes/{guiaId}/cancelar

    Terminal window
    curl -X 'POST' \
      'https://api.integradoor.com.br/api/v2/autorizar/autorizacoes/ec6d5622-8653-4849-a179-f0c6f875f2e3/cancelar' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
      "motivoCancelamento": "Teste de emissão"
    }'

  2. Cancelar uma autorização utilizando a guia do prestador ou do parceiro

    Use este método quando você possui a guiaPrestador ou guiaParceiro como referência da autorização.

    Utilize o endpoint: POST /api/v2/autorizar/autorizacoes/{guiaPrestadorOuParceiro}/cancelar

    Terminal window
    curl -X 'POST' \
      'https://api.integradoor.com.br/api/v2/autorizar/autorizacoes/20250530102255/cancelar' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
      "motivoCancelamento": "Teste de emissão"
    }'

Validações e Fluxos Alternativos

Tentativa de cancelamento fora do prazo permitido

Caso a autorização esteja fora do período de cancelamento (por exemplo, mais de 5 dias após a emissão), a API retornará uma mensagem de erro.

{
  "sucesso": false,
  "mensagem": "Não é possível cancelar esta autorização. O prazo para cancelamento expirou."
}

Guia não encontrada

Se a guiaId, guiaPrestador ou guiaParceiro informada não existir ou não pertencer à credencial do solicitante, a resposta indicará o erro.

{
  "sucesso": false,
  "mensagem": "Guia não encontrada ou não vinculada à sua credencial"
}

Falta de justificativa

A justificativa do cancelamento é obrigatória. Se o campo não for informado ou estiver em branco, a API responderá com erro de validação.

{
  "sucesso": false,
  "mensagem": "A justificativa para o cancelamento é obrigatória"
}