Documentação das APIs

Insere assinatura

Esta API Permite que seja inserido dados na assinatura.

Requisão

CampoTipoDescrição
IdNúmericoIdentificador único da assinatura(opcional)
ClienteIdNúmericoIdentificador único do cliente(opcional)
ClienteNomeTextoNome do cliente que será realizada a cobrança(opcional)
DescricaoTextoBreve descrição sobre a cobrança
ValorNúmericoValor da cobrança(opcional)
CriacaoDataData em que a cobrança foi criada(opcional)
PeriodicidadeTextoPeríodo o qual a cobrança será enviada ao cliente(opcional)
DiasGeracaoCobrancaNúmericoTempo destinado a geração da cobrança(opcional)
IniciandoEmDataTempo o qual ela vai começar a ser enviada ao cliente(opcional)
FinalizandoEmDataTempo o qual ela não vai mais ser enviada ao cliente(opcional)
GerarCarneEEnviarPorCartaBoleanoSe for marcada essa opção será enviado um Carne através de carta para o cliente(opcional)
FormasPagamentoTextoForma de pagamento da cobrança(opcional)
ProdutoIdNúmericoIdentificador único do produto caso houver(opcional)
MultaNúmericoValor da multa caso haja algum tipo de atraso(opcional)
JurosMesNúmericoPorcentagem de juros ao mes após o vencimento(opcional)
DescontoAteVencimentoNúmericoDesconto até a última data do vencimento da assinatura(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 de pagamento(opcional)
ValorNúmeroValor da assinatura(opcional)

Resposta

CampoTipoDescrição
IdNúmericoIdentificador único da assinatura
ClienteIdNúmericoIdentificador único do cliente
ClienteNomeTextoNome do cliente que será realizada a cobrança
DescricaoTextoBreve descrição sobre a cobrança
ValorNúmericoValor da cobrança
CriacaoDataData em que a cobrança foi criada
PeriodicidadeTextoPeríodo o qual a cobrança será enviada ao cliente
DiasGeracaoCobrancaNúmericoTempo destinado a geração da cobrança
IniciandoEmDataTempo o qual ela vai começar a ser enviada ao cliente
FinalizandoEmDataTempo o qual ela não vai mais ser enviada ao cliente
GerarCarneEEnviarPorCartaBoleanoSe for marcada essa opção será enviado um Carne através de carta para o cliente
FormasPagamentoTextoForma de pagamento da cobrança
ProdutoIdNúmericoIdentificador único do produto caso houver
MultaNúmericoValor da multa caso haja algum tipo de atraso
JurosMesNúmericoPorcentagem de juros ao mes após o vencimento
DescontoAteVencimentoNúmericoDesconto até a última data do vencimento da assinatura
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
ClientePagamentosIdTextoId do cliente de pagamento
ValorNúmeroValor da assinatura
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!