--- title: "Cria um protesto" method: POST path: "/api/CriaProtesto" tags: ["Protesto"] --- # Cria um protesto `POST /api/CriaProtesto` ## Request - Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI` - URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/CriaProtesto` - Auth: OAuth 2 - Password - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI` 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 | **Campo** | **Tipo** | **Descrição** | **Obrigatório** | |--|--|--|--| | TransacaoId | GUID | Identificador único da transação. Se não informado, os dados do título devem ser preenchidos manualmente | Não | | CobrancaId | GUID | Identificador único da cobrança. Usado quando o protesto vem do módulo de cobranças, para verificar se tem um protesto associado ativo | Não | | TipoProtesto | Número | Tipo do protesto - "DuplicataMercantil = 0", "DuplicataServico = 1", "Contrato = 2", "CedulaCreditoBancario = 3" | Sim | | ValorAProtestar | Numérico | Valor do saldo devedor atual do título | Sim | | ValorOriginal | Numérico | Valor original do título | Não(1) | | DataEmissao | Data | Data de emissão do título | Não(1) | | DataVencimento | Data | Data de vencimento do título | Não(1) | | **DadosAdicionaisCliente** | **Objeto** | **Dados adicionais do cliente (endereço), usados quando os dados da transação forem insuficientes** | **Não(2)** | | Cep | Texto | Cep do endereço do cliente | Não(6) | | Uf | Texto | Uf do endereço do cliente | Não(6) | | Bairro | Texto | Bairro do endereço do cliente | Não(6) | | Municipio | Texto | Municipio do endereço do cliente | Não(6) | | Endereco | Texto | Endereco completo do cliente | Não(6) | | TituloEndossado | Booleano | Indica se o título foi endossado (há um credor anterior). | Não | | CredorAnteriorId | GUID | Identificador do credor anterior já cadastrado. Obrigatório se TituloEndossado = true e CredorAnterior não for informado. | Não(3)(5) | | **CredorAnterior** | **Objeto** | **Dados do credor anterior preenchidos manualmente** | **Não(4)(5)** | | Documento | Texto | CPF/CNPJ do credor anterior | Não(7) | | Nome | Texto | Nome/Razão Social do credor anterior | Não(7) | | Cep | Texto | Cep do endereço do credor anterior | Não(7) | | Uf | Texto | Uf do endereço do credor anterior | Não(7) | | Bairro | Texto | Bairro do endereço do credor anterior | Não(7) | | Municipio | Texto | Municipio do endereço do credor anterior | Não(7) | | Endereco | Texto | Endereço completo do credor anterior | Não(7) | | **DadosDevedor** | **Objeto** | **Dados do sacado/devedor** | **Não(1)** | | Documento | Texto | Documento do devedor (CPF ou CNPJ) | Não(8) | | Nome | Texto | Nome/Razão Social do devedor | Não(8) | | Email | Texto | Email do devedor | Não | | Celular | Texto | Celular do devedor | Não | | Cep | Texto | Cep do endereço do devedor | Não(8) | | Uf | Texto | Uf do endereço do devedor | Não(8) | | Bairro | Texto | Bairro do endereço do devedor | Não(8) | | Municipio | Texto | Município do endereço do devedor | Não(8) | | Endereco | Texto | Endereço completo do devedor | Não(8) | | Origem | Número | Onde 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 | **Campo** | **Tipo** | **Descrição** | |--|--|--| | Retorno | Texto | Retorno da chamada - "CREATED" ou "ERROR" | | DetalhesErro | Lista de Texto | Detalhes do erro gerado, caso o retorno seja "ERROR" | | TituloId | Número | Identificador do título gerado pelo Protesto24h, no momento de criação é sempre retornado 0 | | ProtestoId | GUID | Identificador único do protesto gerado no sistema, retornado apenas quando a criação é bem sucedida | ## Headers - `Aeskey` string, required ## Request body - BknBankPagamentosBusinessCommunicationRequestCreateProtestRequest - `TransacaoId` string - `CobrancaId` string - `TipoProtesto` 'DuplicataMercantil' | 'DuplicataServico' | 'Contrato' | 'CedulaCreditoBancario', required - `ValorAProtestar` number, double, required - `ValorOriginal` number, double - `DataEmissao` string, date-time - `DataVencimento` string, date-time - `DadosAdicionaisCliente` BknBankPagamentosBusinessCommunicationRequestClientData - `Cep` string - `Uf` string - `Bairro` string - `Municipio` string - `Endereco` string - `TituloEndossado` boolean - `CredorAnteriorId` string, uuid - `CredorAnterior` BknBankPagamentosBusinessCommunicationRequestCredorAnteriorData - `Documento` string - `Nome` string - `Cep` string - `Uf` string - `Bairro` string - `Municipio` string - `Endereco` string - `DadosDevedor` BknBankPagamentosBusinessCommunicationRequestDebtorData - `Documento` string - `Nome` string - `Email` string - `Celular` string - `Cep` string - `Uf` string - `Bairro` string - `Municipio` string - `Endereco` string - `Origem` integer ## Response `201` Protesto criado com sucesso - BknBankPagamentosBusinessCommunicationResponseCreatedProtestResponse - `Retorno` 'CREATED' | 'ERROR' - `DetalhesErro` string[] - `TituloId` integer - `ProtestoId` string, uuid ## Other responses - `400`: Requisição mal formatada ou parâmetros inválidos - `401`: Não autorizado - `403`: Acesso proibido - `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)