Protesto

Consulta o histórico do protesto

Esta API funciona como um portal para a recuperação de informações detalhadas sobre o histórico de um protesto específico.<br />

Requisição

CampoTipoDescriçãoObrigatório
ProtestoIdGUIDId do protestoSim

Resposta

CampoTipoDescrição
IdGUIDId do histórico
ProtestoIdGUIDId do protesto associado ao evento
SequencialInteiroSequencial do evento
SituacaoAnteriorTextoSituação anterior do evento
SituacaoNovaTextoSituação nova do evento
DescricaoTextoDescrição do evento
DadosAdicionaisTextoDados adicionais em formato JSON associados ao evento
DataRegistroDateTimeData do registro do evento
DataAtualizacaoDateTimeData da última atualização do registro
AtivoBooleanoIndica se o registro histórico está ativo
DataTextoCampo legado mantido para compatibilidade
SituacaoTextoCampo legado mantido para compatibilidade
CartorioTextoNome do cartório onde o protesto foi realizado
ProtocoloTextoNúmero do protocolo do protesto
DataProtocoloTextoData do protocolo
ValorTextoValor associado ao protesto
PrazoCancelamentoTextoPrazo para cancelamento do protesto
CodigoPixTextoCódigo PIX para pagamento
MotivoTextoMotivo de rejeição ou devolução
DescricaoMotivoTextoDescrição detalhada do motivo, caso houver
get/api/ConsultaHistoricoProtesto

Request

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

Query parameters

ProtestoIdstring

Id do protesto

Headers

Aeskeystring required

Response

Histórico consultado com sucesso

ProtestoIdstring uuid required
Sequencialinteger
SituacaoAnteriorstring
SituacaoNovastring required
Descricaostring
DadosAdicionaisstring
DataRegistrostring date-time required
DataAtualizacaostring date-time
Ativoboolean
Datastring
Situacaostring
Cartoriostring
Protocolostring
DataProtocolostring
Valorstring
PrazoCancelamentostring
CodigoPixstring
Motivostring
DescricaoMotivostring
DataTransferenciastring
Idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.