1.6.PATCH/api/v1/processo/{idProcesso}/cancelar-processo

O objetivo deste método é permitir que o usuário cancele o processo de assinatura que esteja em andamento.

Neste método o usuário irá nos enviar o ID do Processo, e nós cancelaremos o processo informado.

Requisição


Retorno

Detalhamento do Retorno

Ref. 01 – Código 200: Como retorno de sucesso, a aplicação retornará o código 200 juntamente com a mensagem de documento cancelado com sucesso.

Ref. 02 – Código 400: Mensagem de item obrigatório: Esta mensagem será exibida no singular ou plural quando um ou mais itens obrigatórios não tiver sido enviado na chamada da API.

Ref. 03 – Código 400: Mensagem de formato incorreto: Esta mensagem será exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto.

Ref. 04 – Código 400: Mensagem de Ids inexistente: Esta mensagem será exibida no singular ou plural quando um ou mais Id enviado não existir.

Ref. 05 – Código 400: Mensagem de documento excluído: Esta mensagem será exibida quando o processo em questão tiver sido excluído logicamente.

Ref. 06 – Código 400: Mensagem de parâmetro está incorreto ou é inexistente: Quando a chamada é feita com algum parâmetro escrito errado ou parâmetro que não existe no método.

Ref. 07 – Código 422: Mensagem validações: Estas mensagens serão exibidas quando o usuário informar um com status diferente de Aguardando ou Em processo.

Ref. 08 – Código 401: Mensagem de usuário da API não autorizado: AppKey inválida ou não localizada.

Atualizado há 14 dias

×