get https://pagamentos.k8bank.com.br/CobrancasAPI/api/Produto
O método de produto é uma maneira de simplificar as cobranças, podendo criar uma cobrança padrão para determinado cliente. O produto possui dois tipos: avulso e assinatura.
Avulso: É uma cobrança realizada diretamente com a inserção de todos os dados referente a mesma.
Assinatura: É uma cobrança realizada apenas uma única vez e será disparada automaticamente para o cliente conforme suas informações pré-estabelecidas.
Esta API permite a consulta dos produtos por nome.
Requisição
Campo | Tipo | Descrição |
---|---|---|
nomeContains | Texto | Nome do produto, aceita consulta parcial |
Resposta
Campo | Tipo | Descrição |
---|---|---|
Id | Numérico | Identificador único do produto |
Nome | Texto | Nome do produto |
Tipos | Texto | Tipo do produto avulso ou assinatura |
Multa | Numérico | Porcentagem da multa colocada no produto |
JurosMes | Numérico | Porcentagem dos juros por mês |
DescontoAteVencimento | Numérico | Desconto aplicado até a data do vencimento |
NotificacaoCobrancaDias | Numérico | Dias antes do vencimento da cobrança para enviar a notificação |
NotificacaoCobrancaEmail | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via e-mail |
NotificacaoCobrancaSMS | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via SMS |
NotificacaoCobrancaCartaImpressa | Boleano | Se esta opção estiver marcada o cliente receberá uma notificação via carta |
PrimeiraTentativaHabilitada | Boleano | Primeira tentativa de notificação com os dias vencidos |
PrimeiraTentativaDias | Numérico | Número de dias vencidos |
PrimeiraTentativaEmail | Boleano | Primeira tentativa de notificação com os dias vencidos via e-mail |
PrimeiraTentativaSMS | Boleano | Primeira tentativa de notificação com os dias vencidos via SMS |
SegundaTentativaHabilitada | Boleano | Segunda tentativa de notificação com os dias vencidos |
SegundaTentativaDias | Numérico | Número de dias vencidos |
SegundaTentativaEmail | Boleano | Segunda tentativa de notificação com os dias vencidos via e-mail |
SegundaTentativaSMS | Boleano | Segunda tentativa de notificação com os dias vencidos via SMS |
TerceiraTentativaHabilitada | Boleano | Terceira tentativa de notificação com os dias vencidos |
TerceiraTentativaDias | Numérico | Número de dias vencidos |
TerceiraTentativaEmail | Boleano | Terceira tentativa de notificação com os dias vencidos via e-mail |
TerceiraTentativaSMS | Boleano | Terceira tentativa de notificação com os dias vencidos via SMS |
QuartaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
QuartaTentativaDias | Numérico | Número de dias vencidos |
QuartaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
QuartaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
QuintaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
QuintaTentativaDias | Numérico | Número de dias vencidos |
QuintaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
QuintaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
SextaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
SextaTentativaDias | Numérico | Número de dias vencidos |
SextaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
SextaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
SetimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
SetimaTentativaDias | Numérico | Número de dias vencidos |
SetimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
SetimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
OitavaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
OitavaTentativaDias | Numérico | Número de dias vencidos |
OitavaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
OitavaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
NonaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
NonaTentativaDias | Numérico | Número de dias vencidos |
NonaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
NonaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |
DecimaTentativaHabilitada | Boleano | Quarta tentativa de notificação com os dias vencidos |
DecimaTentativaDias | Numérico | Número de dias vencidos |
DecimaTentativaEmail | Boleano | Quarta tentativa de notificação com os dias vencidos via e-mail |
DecimaTentativaSMS | Boleano | Quarta tentativa de notificação com os dias vencidos via SMS |