post https://pagamentos.meuk8.com.br/PagamentosAPI/api/CriaProtesto
Esta rota permite a criação de um novo protesto no sistema.
Requisição
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
TransacaoId | GUID | Identificador único da transação. | Sim |
TipoProtesto | Texto | Tipo do protesto. Veja valores abaixo. | Sim |
ValorAProtestar | Numérico com 2 decimais | Valor do saldo devedor atual do título. | Sim |
DadosAdicionaisCliente | Texto | Dados adicionais do cliente, usados apenas se os dados da transação forem insuficientes. | Não |
Enum TipoProtesto
Valor Enum | Descrição |
---|---|
0 - DuplicataMercantil | Duplicata Mercantil |
1 - DuplicataServico | Duplicata de Serviço |
2 - Contrato | Contrato |
3 - CedulaCreditoBancario | Cédula de Crédito Bancário |
Resposta
Campo | Tipo | Descrição |
---|---|---|
Retorno | Texto | Retorno da chamada, podendo ser os valores OK ou ERROR. |
DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERROR. |
TituloId | Inteiro | Identificador do título. |
Observações
- Em casos de transações PIX os campos do objeto DadosAdicionaisCliente devem ser preenchidos.
- Se os dados do cliente forem obrigatórios e não forem informados, a requisição resultará em erro 400.