post https://pagamentos.k8bank.com.br/CobrancasAPI/api/v1/Cobranca
Esta API permite que seja inserido uma nova cobrança, através dos dados do cliente.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| Id | Numérico | Identificador único da cobrança(opcional) |
| IdentificadorSequencial | Numérico | Identificador sequencial da cobrança(opcional) |
| ClienteId | GUID | Identificador único do cliente |
| ClienteNome | Texto | Nome do cliente relacionado a cobrança(opcional) |
| Descricao | Texto | Descrição com mais detalhes sobre a cobrança |
| Valor | Data | Valor a ser pago na cobrança |
| Vencimento | Data | Data de vencimento da cobrança! |
| NaoReceberDepoisDe | Data | Data definida para o cliente não receber a cobrança após ela(opcional) |
| Tipo | Texto | Tipo da cobrança, avulsa ou assinatura(opcional) |
| Estado | Texto | Situação da cobrança, paga, não paga, vencida e etc… (opcional) |
| FormasPagamento | Texto | Formas de pagamento da cobrança, pix, cartão, boleto e etc… (opcional) |
| ProdutoId | Numérico | Identificador único do produto(forma simplificada da cobrança) (opcional) |
| Multa | Numérico | Valor da multa a ser aplicado na cobrança(opcional) |
| MultaCorrecao | Numérico | Tipo da multa a ser aplicada, podendo ser= Percentual, Valor, Diário(opcional) |
| JurosMes | Numérico | Juros mensais aplicados sobre o valor da cobrança(opcional) |
| JurosCorrecao | Numérico | Tipo do juros a ser aplicado, podendo ser= Percentual, Valor, Diário(opcional) |
| DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento(opcional) |
| DescontoCorrecao | Numérico | Tipo do desconto a ser aplicado, podendo ser= Percentual, Valor, Diário(opcional) |
| NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação(opcional) |
| NotificacaoCobrancaEmail | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via e-mail(opcional) |
| NotificacaoCobrancaSMS | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via SMS(opcional) |
| PrimeiraTentativaHabilitada | Boleano | Primeira tentativa de notificação com os dias vencidos(opcional) |
| PrimeiraTentativaDias | Numérico | Número de dias vencidos(opcional) |
| PrimeiraTentativaEmail | Boleano | Primeira tentativa de notificação com os dias vencidos via e-mail(opcional) |
| PrimeiraTentativaSMS | Boleano | Primeira tentativa de notificação com os dias vencidos via SMS(opcional) |
| SegundaTentativaHabilitada | Boleano | Segunda tentativa de notificação com os dias vencidos(opcional) |
| SegundaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| SegundaTentativaEmail | Boleano | Segunda tentativa de notificação com os dias vencidos via e-mail(opcional) |
| SegundaTentativaSMS | Boleano | Segunda tentativa de notificação com os dias vencidos via SMS(opcional) |
| TerceiraTentativaHabilitada | Boleano | Terceira tentativa de notificação com os dias vencidos(opcional) |
| TerceiraTentativaDias | Numérico | Número de dias vencidos(opcional) |
| TerceiraTentativaEmail | Boleano | Terceira tentativa de notificação com os dias vencidos via e-mail(opcional) |
| TerceiraTentativaSMS | Boleano | Terceira tentativa de notificação com os dias vencidos via SMS(opcional) |
| QuartaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| QuartaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| QuartaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| QuartaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| QuintaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| QuintaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| QuintaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| QuintaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| SextaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| SextaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| SextaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| SextaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| SetimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| SetimaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| SetimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| SetimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| OitavaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| OitavaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| OitavaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| OitavaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| NonaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| NonaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| NonaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| NonaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| DecimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos(opcional) |
| DecimaTentativaDias | Numérico | Número de dias vencidos(opcional) |
| DecimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail(opcional) |
| DecimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS(opcional) |
| imgBase64 | Imagem | Imagem(opcional) |
| NumeroOperacao | Numérico | Número referente a operação da cobrança(opcional) |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo(opcional) |
| ClientePagamentosId | Texto | Id do cliente do pagamento(opcional) |
| NotaFiscal | Texto | Nota fiscal da Cobrança |