MEmeuk8
Protesto

Cria um protesto

Changed on

Esta rota permite a criação de um novo protesto no sistema.

O protesto pode ser registrado de duas formas:

  • Vinculado a uma transação existente, por meio do envio do TransacaoId
  • De forma manual, sem vínculo com uma transação, quando o TransacaoId não for informado

Em todos os cenários, os custos relacionados ao protesto são de responsabilidade do credor/protestante, não sendo repassados ao devedor

Requisição

CampoTipoDescriçãoObrigatório
TransacaoIdGUIDIdentificador único da transação. Se não informado, os dados do título devem ser preenchidos manualmenteNão
CobrancaIdGUIDIdentificador único da cobrança. Usado quando o protesto vem do módulo de cobranças, para verificar se tem um protesto associado ativoNão
TipoProtestoNúmeroTipo do protesto - "DuplicataMercantil = 0", "DuplicataServico = 1", "Contrato = 2", "CedulaCreditoBancario = 3"Sim
ValorAProtestarNuméricoValor do saldo devedor atual do títuloSim
ValorOriginalNuméricoValor original do títuloNão(1)
DataEmissaoDataData de emissão do títuloNão(1)
DataVencimentoDataData de vencimento do títuloNão(1)
DadosAdicionaisClienteObjetoDados adicionais do cliente (endereço), usados quando os dados da transação forem insuficientesNão(2)
CepTextoCep do endereço do clienteNão(6)
UfTextoUf do endereço do clienteNão(6)
BairroTextoBairro do endereço do clienteNão(6)
MunicipioTextoMunicipio do endereço do clienteNão(6)
EnderecoTextoEndereco completo do clienteNão(6)
TituloEndossadoBooleanoIndica se o título foi endossado (há um credor anterior).Não
CredorAnteriorIdGUIDIdentificador do credor anterior já cadastrado. Obrigatório se TituloEndossado = true e CredorAnterior não for informado.Não(3)(5)
CredorAnteriorObjetoDados do credor anterior preenchidos manualmenteNão(4)(5)
DocumentoTextoCPF/CNPJ do credor anteriorNão(7)
NomeTextoNome/Razão Social do credor anteriorNão(7)
CepTextoCep do endereço do credor anteriorNão(7)
UfTextoUf do endereço do credor anteriorNão(7)
BairroTextoBairro do endereço do credor anteriorNão(7)
MunicipioTextoMunicipio do endereço do credor anteriorNão(7)
EnderecoTextoEndereço completo do credor anteriorNão(7)
DadosDevedorObjetoDados do sacado/devedorNão(1)
DocumentoTextoDocumento do devedor (CPF ou CNPJ)Não(8)
NomeTextoNome/Razão Social do devedorNão(8)
EmailTextoEmail do devedorNão
CelularTextoCelular do devedorNão
CepTextoCep do endereço do devedorNão(8)
UfTextoUf do endereço do devedorNão(8)
BairroTextoBairro do endereço do devedorNão(8)
MunicipioTextoMunicípio do endereço do devedorNão(8)
EnderecoTextoEndereço completo do devedorNão(8)
OrigemNúmeroOnde se originou o protesto - "Pay" = 0, "Cob" = 1 (padrão: 0)Não

(1) - Obrigatório caso TransacaoId não for informado (2) - Obrigatório caso a transação informada pelo transacaoId não possua dados de endereço (3) - Obrigatório se TituloEndossado = true e CredorAnterior não for informado (4) - Obrigatório se TituloEndossado = true e CredorAnteriorId não for informado (5) - Caso informado, deve ser apenas CredorAnteriorId ou CredorAnterior, não ambos (6) - Obrigatório caso o DadosAdicionaisCliente seja informado (7) - Obrigatório caso o CredorAnterior seja informado (8) - Obrigatório caso o DadosDevedor seja informado

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada - "CREATED" ou "ERROR"
DetalhesErroLista de TextoDetalhes do erro gerado, caso o retorno seja "ERROR"
TituloIdNúmeroIdentificador do título gerado pelo Protesto24h, no momento de criação é sempre retornado 0
ProtestoIdGUIDIdentificador único do protesto gerado no sistema, retornado apenas quando a criação é bem sucedida
post/api/CriaProtesto

Request

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

Headers

Aeskeystring required

Request body

TransacaoIdstring
CobrancaIdstring
TipoProtesto'DuplicataMercantil' | 'DuplicataServico' | 'Contrato' | 'CedulaCreditoBancario' required
ValorAProtestarnumber double required
ValorOriginalnumber double
DataEmissaostring date-time
DataVencimentostring date-time
TituloEndossadoboolean
CredorAnteriorIdstring uuid
Origeminteger

Example request

{
  "TipoProtesto": "DuplicataMercantil",
  "ValorAProtestar": 1500,
  "ValorOriginal": 1800,
  "DataEmissao": "2026-07-19T10:15:28.7308514-03:00",
  "DataVencimento": "2026-08-29T10:15:28.7308514-03:00",
  "DadosAdicionaisCliente": {
    "Cep": "01310930",
    "Uf": "SP",
    "Bairro": "Bela Vista",
    "Municipio": "São Paulo",
    "Endereco": "Av. Paulista, 1000"
  },
  "TituloEndossado": true,
  "CredorAnterior": {
    "Documento": "12345678000190",
    "Nome": "Empresa Anterior LTDA",
    "Cep": "70040900",
    "Uf": "DF",
    "Bairro": "Asa Sul",
    "Municipio": "Brasília",
    "Endereco": "SBS Quadra 1"
  },
  "DadosDevedor": {
    "Documento": "12345678901",
    "Nome": "João da Silva",
    "Email": "joao.silva@example.com",
    "Celular": "11999998888",
    "Cep": "01310930",
    "Uf": "SP",
    "Bairro": "Bela Vista",
    "Municipio": "São Paulo",
    "Endereco": "Av. Paulista, 123"
  }
}

Response

Protesto criado com sucesso

Retorno'CREATED' | 'ERROR'
DetalhesErrostring[]
TituloIdinteger
ProtestoIdstring uuid

Example response

{
  "ProtestoId": "00000000-0000-0000-0000-000000000000"
}

Changes

  • a8b4ea0aa298Revision changes
    • info

      api operation id Protesto_Register removed and replaced with Protesto_Register_Register_POST

    • 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/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/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