---
title: "Consulta protestos filtrando por data de inclusão e situação"
method: GET
path: "/api/ConsultaProtesto"
tags: ["Protesto"]
---

# Consulta protestos filtrando por data de inclusão e situação

`GET /api/ConsultaProtesto`

## Request

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

Esta rota permite consultar uma lista de protestos filtrando por data de inclusão (dataInicial e dataFinal) e, opcionalmente, pela situação do protesto.
            
### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--|
| DataInicial | Data | Data inicial da inclusão do protesto | Sim |
| DataFinal | Data | Data final da inclusão do protesto | Sim |
| Situacao | Texto | Situação do protesto | Não |
| TituloID | Número | Número do título (busca exata) | Não |
| Start | Número | Índice de paginação inicial | Não |
| Size | Número | Tamanho da página (padrão: 10) | Não |
            
### Resposta
| **Campo** | **Tipo** | **Descrição** |
|--|--|--|
| Id | GUID | Identificador único do protesto |
| TransacaoId | GUID | Identificador da transação relacionada, caso não exista será retornado um GUID vazio |
| CobrancaId | GUID | Identificador da cobrança associada, caso exista |
| TituloID | Número | Identificador do título registrado |
| ClienteId | GUID | Identificador do cliente proprietário |
| ClienteNome | Texto | Nome do cliente proprietário do protesto |
| CredorNome | Texto | Nome do credor do título protestado |
| DevedorNome | Texto | Nome do devedor do título protestado |
| Descricao | Texto | Descrição adicional do protesto |
| Tipo | Número | Tipo do protesto - "DuplicataMercantil = 0", "DuplicataServico = 1", "Contrato = 2", "CedulaCreditoBancario = 3" |
| TipoDescricao | Texto | Descrição amigável do tipo de título/protesto |
| Identificador | Texto | Referência externa atribuída ao título |
| DataEmissao | Data | Data de emissão do título |
| DataInclusao | Data | Data em que o protesto foi incluído no sistema |
| DataCriacao | Data | Data em que o protesto foi criado |
| DataVencimento | Data | Data de vencimento do título |
| VencimentoTransacao | Data | Data de vencimento da transação |
| Ativo | Booleano | Indica se o protesto está ativo ou inativo |
| Situacao | Texto | Situação atual do protesto |
| SituacaoAmigavel | Texto | Status formatado de forma amigável para exibição na UI |
| SituacaoDetalhada | Texto | Descrição detalhada do status individual (ex: "Aguardando Coleta", "Protestado") |
| SituacaoCompleta | Texto | Descrição completa com grupo amigável e status original do Protesto24h |
| GrupoStatus | Texto | Grupo do status |
| NomeGrupo | Texto | Nome do grupo formatado (mesmo que SituacaoAmigavel) |
| MotivoRejeicao | Texto | Motivo da rejeição quando o status for DEVOLVIDO |
| DescricaoMotivoRejeicao | Texto | Descrição detalhada do motivo da rejeição quando o status for DEVOLVIDO |
| DescricaoErro | Texto | Descrição do erro quando o status for ERRO_PROCESSAMENTO |
| ValorTotal | Numérico | Valor total do título |
| ValorSaldo | Numérico | Valor de saldo pendente do título |
| ValorTaxas | Numérico | Valor total das taxas associadas |
| ClasseBadge | Texto | Classe CSS para badge do status |
| HtmlTooltipMotivoRejeicao | Texto | HTML do ícone de informação com tooltip do motivo da rejeição quando aplicável |

## Query parameters

- `DataInicial` string, date-time, required
- `DataFinal` string, date-time, required
- `Situacao` string
- `TituloID` integer
- `Start` integer
- `Size` integer

## Headers

- `Aeskey` string, required

## Response `200`

Consulta realizada com sucesso

- BknBankPagamentosBusinessProtestoDtoProtestoResponseDto[]
  - `Id` string, uuid
  - `TransacaoId` string, uuid
  - `CobrancaId` string, uuid
  - `TituloID` integer
  - `ClienteId` string, uuid
  - `ClienteNome` string
  - `CredorNome` string
  - `DevedorNome` string
  - `Descricao` string
  - `Tipo` integer
  - `TipoDescricao` string
  - `Identificador` string
  - `DataEmissao` string, date-time
  - `DataInclusao` string, date-time
  - `DataCriacao` string, date-time
  - `DataVencimento` string, date-time
  - `VencimentoTransacao` string, date-time
  - `Ativo` boolean
  - `Situacao` string
  - `SituacaoAmigavel` string
  - `SituacaoDetalhada` string
  - `SituacaoCompleta` string
  - `GrupoStatus` 'Preparacao' | 'EmProcessamento' | 'EmCartorio' | 'EncerradoPago' | 'EncerradoProtestado' | 'EncerradoDevolvidoImpedido' | 'EncerradoRetirado' | 'EncerradoCancelado' | 'Judicial'
  - `NomeGrupo` string
  - `MotivoRejeicao` string
  - `DescricaoMotivoRejeicao` string
  - `DescricaoErro` string
  - `ValorTotal` number, double
  - `ValorSaldo` number, double
  - `ValorTaxas` number, double
  - `ClasseBadge` string
  - `HtmlTooltipMotivoRejeicao` string

## Other responses

- `400`: Parâmetros obrigatórios ausentes ou inválidos
- `401`: Não autorizado
- `403`: Acesso proibido
- `404`: Nenhum protesto encontrado com os filtros informados
- `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)