Protesto
Consulta um protesto por TituloID
Esta rota permite consultar os dados de um protesto específico a partir do identificador do título.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| TituloId | Número | Identificador do título | Sim |
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 |
get/api/ConsultaProtestoPorId
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/ConsultaProtestoPorId
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Query parameters
TituloIdinteger required
Headers
Aeskeystring required
Response
Consulta realizada com sucesso
Example response
{
"Id": "00000000-0000-0000-0000-000000000000",
"TransacaoId": "00000000-0000-0000-0000-000000000000",
"CobrancaId": "00000000-0000-0000-0000-000000000000",
"ClienteId": "00000000-0000-0000-0000-000000000000"
}Changes
No recorded changes to this operation across all 1 revision of this API.