MEmeuk8
Protesto

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

Changed on

Esta rota permite consultar uma lista de protestos filtrando por data de inclusão (dataInicial e dataFinal) e, opcionalmente, pela situação e tituloId do protesto

Requisição

CampoTipoDescriçãoObrigatório
DataInicialDataData inicial da inclusão do protestoSim
DataFinalDataData final da inclusão do protestoSim
SituacaoTextoSituação do protestoNão
TituloIDNúmeroNúmero do título (busca exata)Não
StartNúmeroÍndice de paginação inicialNão
SizeNúmeroTamanho da página (padrão: 10)Não

Resposta

CampoTipoDescrição
IdGUIDIdentificador único do protesto
TransacaoIdGUIDIdentificador da transação relacionada, caso não exista será retornado um GUID vazio
CobrancaIdGUIDIdentificador da cobrança associada, caso exista
TituloIDNúmeroIdentificador do título registrado
ClienteIdGUIDIdentificador do cliente proprietário
ClienteNomeTextoNome do cliente proprietário do protesto
CredorNomeTextoNome do credor do título protestado
DevedorNomeTextoNome do devedor do título protestado
DescricaoTextoDescrição adicional do protesto
TipoNúmeroTipo do protesto - "DuplicataMercantil = 0", "DuplicataServico = 1", "Contrato = 2", "CedulaCreditoBancario = 3"
TipoDescricaoTextoDescrição amigável do tipo de título/protesto
IdentificadorTextoReferência externa atribuída ao título
DataEmissaoDataData de emissão do título
DataInclusaoDataData em que o protesto foi incluído no sistema
DataCriacaoDataData em que o protesto foi criado
DataVencimentoDataData de vencimento do título
VencimentoTransacaoDataData de vencimento da transação
AtivoBooleanoIndica se o protesto está ativo ou inativo
SituacaoTextoSituação atual do protesto
SituacaoAmigavelTextoStatus formatado de forma amigável para exibição na UI
SituacaoDetalhadaTextoDescrição detalhada do status individual (ex: "Aguardando Coleta", "Protestado")
SituacaoCompletaTextoDescrição completa com grupo amigável e status original do Protesto24h
GrupoStatusTextoGrupo do status
NomeGrupoTextoNome do grupo formatado (mesmo que SituacaoAmigavel)
MotivoRejeicaoTextoMotivo da rejeição quando o status for DEVOLVIDO
DescricaoMotivoRejeicaoTextoDescrição detalhada do motivo da rejeição quando o status for DEVOLVIDO
DescricaoErroTextoDescrição do erro quando o status for ERRO_PROCESSAMENTO
ValorTotalNuméricoValor total do título
ValorSaldoNuméricoValor de saldo pendente do título
ValorTaxasNuméricoValor total das taxas associadas
ClasseBadgeTextoClasse CSS para badge do status
HtmlTooltipMotivoRejeicaoTextoHTML do ícone de informação com tooltip do motivo da rejeição quando aplicável
get/api/ConsultaProtesto

Request

  • Base URL
    https://pagamentos.meuk8.com.br/PagamentosAPI
  • URL
    https://pagamentos.meuk8.com.br/PagamentosAPI/api/ConsultaProtesto
  • Auth
    OAuth 2
    Password
    Token URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI

Query parameters

DataInicialstring date-time required
DataFinalstring date-time required
Situacaostring
TituloIDinteger
Startinteger
Sizeinteger

Headers

Aeskeystring required

Response

Consulta realizada com sucesso

Idstring uuid
TransacaoIdstring uuid
CobrancaIdstring uuid
TituloIDinteger
ClienteIdstring uuid
ClienteNomestring
CredorNomestring
DevedorNomestring
Descricaostring
Tipointeger
TipoDescricaostring
Identificadorstring
DataEmissaostring date-time
DataInclusaostring date-time
DataCriacaostring date-time
DataVencimentostring date-time
VencimentoTransacaostring date-time
Ativoboolean
Situacaostring
SituacaoAmigavelstring
SituacaoDetalhadastring
SituacaoCompletastring
GrupoStatus'Preparacao' | 'EmProcessamento' | 'EmCartorio' | 'EncerradoPago' | 'EncerradoProtestado' | 'EncerradoDevolvidoImpedido' | 'EncerradoRetirado' | 'EncerradoCancelado' | 'Judicial'
NomeGrupostring
MotivoRejeicaostring
DescricaoMotivoRejeicaostring
DescricaoErrostring
ValorTotalnumber double
ValorSaldonumber double
ValorTaxasnumber double
ClasseBadgestring
HtmlTooltipMotivoRejeicaostring

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

  • a8b4ea0aa298Revision changes
    • info

      api operation id Protesto_GetByFilters removed and replaced with Protesto_GetByFilters_GetByFilters_GET

    • info

      the security scope BknBankPagamentosAPI was added to the endpoint's security scheme oauth2

    • info

      the security scope BknBankCobrancasAPI was removed from the endpoint's security scheme oauth2

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/xml for the response with the status

    • info

      added the media type application/xml for the response with the status

    • info

      added the media type application/xml for the response with the status

    • info

      added the media type application/xml for the response with the status

    • info

      added the media type text/json for the response with the status

    • info

      added the media type text/json for the response with the status

    • info

      added the media type text/json for the response with the status

    • info

      added the media type text/json for the response with the status

    • info

      added the media type text/xml for the response with the status

    • info

      added the media type text/xml for the response with the status

    • info

      added the media type text/xml for the response with the status

    • info

      added the media type text/xml for the response with the status

    • info

      removed the non-success response with the status