post https://pagamentos.k8bank.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ê | Não |
| Valor | Numérico | Valor individual de cada parcela do carnê. | Sim |
| QuantidadeParcelas | Numérico | Quantidade de parcelas do carnê (mínimo de duas parcelas) | Sim |
| Vencimento | Texto | Data de venciomento do carnê | Sim |
| NaoReceberDepoisDe | Texto | Data definida para o cliente não receber a cobrança após ela | Não |
| URLConfirmacao | Texto | URL fornecida pelo integrado para notificações à respeito do carnê | Não |
| FormasPagamento | Texto | Boleto ou Boleto Híbrido | Sim |
| ProdutoId | GUID | Identificador único do produto | Não |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança | Não |
| MultaCorrecao | Texto | Tipo da multa a ser aplicada, podendo ser: NaoTemMulta, ValorFixo, ValorPercentual | Não |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança | Não |
| JurosCorrecao | Texto | Tipo do juros a ser aplicado, podendo ser: ValorAoDia, TaxaMensal, Isento | Não |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento | Não |
| DescontoCorrecao | Texto | Tipo do desconto a ser aplicado, podendo ser: NaoTemDesconto, ValorFixoAteDataInformada, PercentualADataInformada | 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 | CarneParcelas | Lista com o detalhamento de cada parcela |
| CobrancaId | GUID | Identificador único da Cobrança gerada |
| Estado | Texto | Estado da cobrança |
| Valor | Numérico | Valor da parcela |
| Vencimento | Texto | Data de venciomento 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 de cola do pix (se for gerado como Boleto Híbrido) |
| QRCodeImagem | Texto | Imagem do QRCode do pix (se for gerado como Boleto Híbrido) |