post
https://pagamentos.meuk8.com.br/CobrancasAPI/api/CobrancaCarne/InsereCarne
Esta API permite cadastrar uma cobrança do tipo carnê.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| ClienteId | GUID | ID do pagador já cadastrado | Sim |
| Descricao | Texto | Descrição do carnê | Sim |
| Valor | Numérico | Valor individual de cada parcela do carnê | Sim |
| QuantidadeParcelas | Número | Quantidade de parcelas do carnê (mínimo de duas parcelas) | Sim |
| Vencimento | Data | Data de vencimento do carnê | Sim |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela | Não |
| Multa | Numérico | Valor da multa a ser aplicada na cobrança | Não |
| MultaCorrecao | Texto | Tipo da multa a ser aplicada - Percentual, Valor | Não |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança | Não |
| JurosCorrecao | Texto | Tipo do juros a ser aplicado - Percentual, Valor | Não |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento | Não |
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado - Percentual, Valor | Não |
| Instrucao1 | Texto | Instrução adicional para o carnê | Não |
| Instrucao2 | Texto | Instrução adicional para o carnê | Não |
| Instrucao3 | Texto | Instrução adicional para o carnê | Não |
| Instrucao4 | Texto | Instrução adicional para o carnê | Não |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| CarneId | GUID | Identificador único do carnê gerado |
| Estado | Texto | Estado que o carnê se encontra |
| ImgBase64 | Texto | Base64 do PDF completo do carnê |
| Parcelas | Lista de Objetos | Lista com o detalhamento de cada parcela |
| CobrancaId | GUID | Identificador único da Cobrança gerada |
| EstadoParcela | Texto | Estado da cobrança |
| Valor | Numérico | Valor da parcela |
| Vencimento | Data | Data de vencimento da parcela |
| NossoNumero | Texto | Nosso Número do boleto gerado |
| LinhaDigitavel | Texto | Linha digitável do boleto gerado |
| CodigoBarras | Texto | Código de Barras do boleto gerado |
| QRCodeTexto | Texto | Copia e cola do pix (se for gerado como Boleto Híbrido) |
| QRCodeImagem | Texto | Imagem do QRCode do pix (se for gerado como Boleto Híbrido) |
| DadosPagamento | Objeto | Dados do pagamento |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…