---
title: "Solicita o cancelamento de um protesto"
method: DELETE
path: "/api/CancelaProtesto"
tags: ["Protesto"]
---

# Solicita o cancelamento de um protesto

`DELETE /api/CancelaProtesto`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI`
- URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/CancelaProtesto`
- Auth: OAuth 2
  - Password
  - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI`

Esta rota realiza a solicitação de cancelamento de um protesto a partir do identificador do título ou do protesto e do tipo do cancelamento
            
### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--|
| TituloId | Número | ID do título no Protesto24h. Se 0, indica que não existe título e deve buscar pelo ProtestoId | Não(1) |
| ProtestoId | GUID | Identificador único do protesto. Usado quando TituloId = 0 para buscar o protesto sem título | Não(2) |
| TipoCancelamento | Número | Tipo de cancelamento - "AUTORIZACAO" = 0, "CANCELAMENTO_ENVIO" = 1, "PEDIDO_CANCELAMENTO" = 2 | Sim |
| WebhookUrl | Texto | URL do webhook do cliente para notificações de cancelamento. Se informada, substitui a URL do cliente | Não |
            
(1) - Obrigatório caso ProtestoId não seja informado
(2) - Obrigatório caso TituloId seja 0 (zero)

### Resposta
| **Campo** | **Tipo** | **Descrição** |
|--|--|--|
| Retorno | Texto | Retorno da chamada, podendo ser os valores "CREATED", "OK", "ERROR" ou "DELETED" |
| DetalhesErro | Lista de Texto | Detalhes do erro gerado, caso o retorno seja ERROR. Pode ser null |
| TituloId | Número | Identificador do título registrado. Pode ser 0 quando o título ainda não foi criado (apenas o protesto existe) |
| ProtestoId | GUID | Identificador único do protesto no sistema |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessCommunicationRequestCancelProtestRequest
  - `TituloId` integer
  - `ProtestoId` string, uuid
  - `TipoCancelamento` 'AUTORIZACAO' | 'CANCELAMENTO_ENVIO' | 'PEDIDO_CANCELAMENTO'
  - `WebhookUrl` string

## Response `200`

Solicitação de cancelamento do protesto concluída com sucesso.

- BknBankPagamentosBusinessCommunicationResponseDeletedProtestResponse
  - `Retorno` 'CREATED' | 'OK' | 'ERROR' | 'DELETED'
  - `DetalhesErro` string[]
  - `TituloId` integer
  - `ProtestoId` string, uuid

## Other responses

- `400`: Parâmetro inválido ou erro de validação de negócio
- `401`: Não autorizado
- `403`: Acesso proibido
- `404`: Protesto não encontrado
- `500`: Erro interno no servidor

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)