Cria um protesto

post

https://pagamentos.meuk8.com.br/CobrancasAPI/api/CriaProtesto

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

Campo	Tipo	Descrição	Obrigatório
CobrancaId	GUID (string)	Identificador único da cobrança. Opcional para permitir protesto avulso.	Não
TipoProtesto	Enum (int)	Tipo do protesto. Veja valores abaixo	Sim
ValorAProtestar	Decimal	Valor do saldo devedor atual do título	Sim
ValorOriginal	Decimal?	Valor original do título. Obrigatório quando CobrancaId não for informado.	Condicional**
DataEmissao	DateTime?	Data de emissão do título. Obrigatório quando CobrancaId não for informado.	Condicional**
DataVencimento	DateTime?	Data de vencimento do título. Obrigatório quando CobrancaId não for informado.	Condicional**
DadosDevedor	Objeto	Dados do sacado/devedor. Obrigatório quando CobrancaId não for informado. Veja estrutura abaixo.	Condicional**
DadosAdicionaisCliente	Objeto	Dados adicionais do cliente (endereço), usados quando os dados da cobrança forem insuficientes. Veja estrutura abaixo.	Não
TituloEndossado	Boolean?	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.	Condicional***
CredorAnterior	Objeto	Dados do credor anterior preenchidos manualmente. Obrigatório se TituloEndossado = true e CredorAnteriorId não for informado. Veja estrutura abaixo.	Condicional***

**Obrigatórios apenas quando CobrancaId não for informado: ValorOriginal, DataEmissao, DataVencimento, DadosDevedor.

***Obrigatório apenas quando TituloEndossado = true. Deve informar CredorAnteriorId OU CredorAnterior (não ambos).

Campo	Tipo	Descrição	Obrigatório
Documento	String	CPF/CNPJ do devedor	Sim (quando CobrancaId não informado)
Nome	String	Nome/Razão Social do devedor	Sim (quando CobrancaId não informado)
Email	String	Email do devedor	Não
Celular	String	Celular do devedor	Não
Cep	String	CEP do endereço do devedor	Sim (quando CobrancaId não informado)
Uf	String	UF do endereço do devedor	Sim (quando CobrancaId não informado)
Bairro	String	Bairro do endereço do devedor	Sim (quando CobrancaId não informado)
Municipio	String	Município do endereço do devedor	Sim (quando CobrancaId não informado)
Endereco	String	Endereço completo do devedor	Sim (quando CobrancaId não informado)

Campo	Tipo	Descrição	Obrigatório
Documento	String	CPF/CNPJ do credor anterior	Sim (quando TituloEndossado = true)
Nome	String	Nome/Razão Social do credor anterior	Sim (quando TituloEndossado = true)
Cep	String	CEP do endereço do credor anterior	Sim (quando TituloEndossado = true)
Uf	String	UF do endereço do credor anterior	Sim (quando TituloEndossado = true)
Bairro	String	Bairro do endereço do credor anterior	Sim (quando TituloEndossado = true)
Municipio	String	Município do endereço do credor anterior	Sim (quando TituloEndossado = true)
Endereco	String	Endereço completo do credor anterior	Sim (quando TituloEndossado = true)

Campo	Tipo	Descrição	Obrigatório
Cep	String	CEP do endereço do cliente	Não
Uf	String	UF do endereço do cliente	Não
Bairro	String	Bairro do endereço do cliente	Não
Municipio	String	Município do endereço do cliente	Não
Endereco	String	Endereço completo do cliente	Não

Campo	Tipo	Descrição
Retorno	String	Retorno da chamada, podendo ser os valores "CREATED" ou "ERROR".
DetalhesErro	List<String>	Detalhes do erro gerado, caso o retorno seja ERROR.
TituloId	Int	Identificador do título gerado pelo Protesto24h. Será 0 quando o título ainda não foi criado (processo assíncrono).
ProtestoId	GUID	Identificador único do protesto criado. Disponível imediatamente após a criação.

Informe o CobrancaId da cobrança.
Campos obrigatórios: TipoProtesto, ValorAProtestar.
Campos opcionais: DadosAdicionaisCliente (quando os dados do cliente forem insuficientes), TituloEndossado, CredorAnterior/CredorAnteriorId.

Não informe o CobrancaId (ou informe null).
Campos obrigatórios: TipoProtesto, ValorAProtestar, ValorOriginal, DataEmissao, DataVencimento, DadosDevedor.
Campos opcionais: DadosAdicionaisCliente, TituloEndossado, CredorAnterior/CredorAnteriorId.

Se os dados obrigatórios não forem informados, a requisição resultará em erro 400.
Quando TituloEndossado = true, é obrigatório informar CredorAnteriorId OU CredorAnterior (não ambos).
O custo do protesto é sempre assumido pelo credor/protestante, nunca pelo devedor.

Language

Credentials

OAuth2

Click Try It! to start a request and see the response here!