Documentação das APIs

Atualiza uma cobrança

Esta API permite a atualização dos dados da cobrança.

Requisição

CampoTipoDescrição
IdNuméricoIdentificador único da cobrança(opcional)
IdentificadorSequencialNuméricoIdentificador sequencial da cobrança(opcional)
ClienteIdNuméricoIdentificador único do cliente(opcional)
ClienteNomeTextoNome do cliente relacionado a cobrança(opcional)
DescricaoTextoDescrição com mais detalhes sobre a cobrança(opcional)
ValorDataValor a ser pago na cobrança(opcional)
CriacaoDataData em que a cobrança foi gerada(opcional)
VencimentoDataData de vencimento da cobrança(opcional)
NaoReceberDepoisDeDataData definida para o cliente não receber a cobrança após ela(opcional)
TipoTextoTipo da cobrança, avulsa ou assinatura(opcional)
EstadoTextoSituação da cobrança, paga, não paga, vencida e etc… (opcional)
FormasPagamentoTextoFormas de pagamento da cobrança, pix, cartão, boleto e etc… (opcional)
ProdutoIdNuméricoIdentificador único do produto(forma simplificada da cobrança) (opcional)
MultaNuméricoValor da multa a ser aplicado na cobrança(opcional)
MultaCorrecaoNuméricoTipo da multa a ser aplicada, podendo ser= Percentual, Valor, Diário(opcional)
JurosMesNuméricoJuros mensais aplicados sobre o valor da cobrança(opcional)
JurosCorrecaoNuméricoTipo do juros a ser aplicado, podendo ser= Percentual, Valor, Diário(opcional)
DescontoAteVencimentoNuméricoDesconto aplicado até a data do vencimento(opcional)
DescontoCorrecaoNuméricoTipo do desconto a ser aplicado, podendo ser=  Percentual, Valor, Diário(opcional)
DadosPagamentoTextoSituação sobre os dados do pagamento da cobrança(opcional)
NotificacaoCobrancaDiasNuméricoDias antes do vencimento da cobrança para enviar a notificação(opcional)
NotificacaoCobrancaEmailBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via e-mail(opcional)
NotificacaoCobrancaSMSBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via SMS(opcional)
NotificacaoCobrancaCartaImpressaBoleanoSe esta opção estiver marcada o cliente receberá uma notificação via carta(opcional)
PrimeiraTentativaHabilitadaBoleanoPrimeira tentativa de notificação com os dias vencidos(opcional)
PrimeiraTentativaDiasNuméricoNúmero de dias vencidos(opcional)
PrimeiraTentativaEmailBoleanoPrimeira tentativa de notificação com os dias vencidos via e-mail(opcional)
PrimeiraTentativaSMSBoleanoPrimeira tentativa de notificação com os dias vencidos via SMS(opcional)
SegundaTentativaHabilitadaBoleanoSegunda tentativa de notificação com os dias vencidos(opcional)
SegundaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SegundaTentativaEmailBoleanoSegunda tentativa de notificação com os dias vencidos via e-mail(opcional)
SegundaTentativaSMSBoleanoSegunda tentativa de notificação com os dias vencidos via SMS(opcional)
TerceiraTentativaHabilitadaBoleanoTerceira tentativa de notificação com os dias vencidos(opcional)
TerceiraTentativaDiasNuméricoNúmero de dias vencidos(opcional)
TerceiraTentativaEmailBoleanoTerceira tentativa de notificação com os dias vencidos via e-mail(opcional)
TerceiraTentativaSMSBoleanoTerceira tentativa de notificação com os dias vencidos via SMS(opcional)
QuartaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
QuartaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
QuartaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
QuartaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
QuintaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
QuintaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
QuintaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
QuintaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
SextaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
SextaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SextaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
SextaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
SetimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
SetimaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
SetimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
SetimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
OitavaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
OitavaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
OitavaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
OitavaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
NonaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
NonaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
NonaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
NonaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
DecimaTentativaHabilitadaBoleanoQuarta tentativa de notificação com os dias vencidos(opcional)
DecimaTentativaDiasNuméricoNúmero de dias vencidos(opcional)
DecimaTentativaEmailBoleanoQuarta tentativa de notificação com os dias vencidos via e-mail(opcional)
DecimaTentativaSMSBoleanoQuarta tentativa de notificação com os dias vencidos via SMS(opcional)
imgBase64ImagemImagem(opcional)
NumeroOperacaoNuméricoNúmero referente a operação da cobrança(opcional)
SplitValoresArrayArray 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)
ClientePagamentosIdTextoId do cliente do pagamento(opcional)
Pagamento--
IdTextoId do pagamento(opcional)
SituacaoTextoSituação do pagamento, podendo ser = pendente, pago, atrasado (opcional)
DataPagamentoTextoData do pagamento(opcional)
FormaPagamentoTextoForma de pagamento, podendo ser = Nenhuma, Boleto, Cartao, Pix, Manual, Protesto, SaldoWebConta (opcional)
DadosPagamentoTextoDados do pagamento(opcional)
ValorPagoNúmeroValor pago de pagamento(opcional)
ValorPrincipalNúmeroValor principal de pagamento(opcional)
ValorMultaJurosNúmeroValor multa/juros de pagamento(opcional)
NumeroPagamentoTextoNúmero do pagamento(opcional)
ValorTaxasNúmeroValor das taxas de pagamento(opcional)
ValorLiquidoNúmeroValor líquido de pagamento(opcional)
DataDisponibilizacaoTextoData de disponibilização pagamento(opcional)
ReembolsadoAoClienteBoleanoIndicação de reembolsado ao cliente do pagamento(opcional)
AntecipadoBoleanoIndicativo se o pagamento foi antecipado(opcional)
SplitCobrancaRequest--
ClientePagamentosIdTextoId do cliente do pagamento(opcional)
ValorNúmeroValor da cobrança(opcional)
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!