post https://pagamentos.meuk8.com.br/CobrancasAPI/api/Assinatura
Esta API Permite que seja inserido dados na assinatura.
Requisão
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
Id | GUID | Identificador único da assinatura | Não |
ClienteId | GUID | Identificador único do cliente | Sim |
ClienteNome | Texto | Nome do cliente relacionado a assinatura, somente para retornar dados | Não |
Descricao | Texto | Breve descrição sobre a cobrança | Sim |
Valor | Numérico | Valor da cobrança | Sim |
Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente | Sim |
DiasGeracaoCobranca | Numérico | Dias para gerar a cobrança de assinatura | Não |
IniciandoEm | Data | Data de início da assinatura | Sim |
FinalizandoEm | Data | Data de fim da assinatura | Não |
FormasPagamento | Texto | Forma de pagamento da cobrança | Não |
ProdutoId | GUID | Identificador único do produto caso houver | Não |
Multa | Numérico | Valor da multa caso haja algum tipo de atraso | Não |
JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento | Não |
DescontoAteVencimento | Numérico | Desconto até a última data do vencimento da assinatura | Não |
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 | Não |
ClientePagamentosId | GUID | Id do cliente de pagamento | Não |
Valor | Número | Valor da assinatura | Sim |
Resposta
Campo | Tipo | Descrição |
---|---|---|
Id | GUID | Identificador único da assinatura |
ClienteId | GUID | Identificador único do cliente |
ClienteNome | Texto | Nome do cliente relacionado a assinatura, somente para retornar dados |
Descricao | Texto | Breve descrição sobre a cobrança |
Valor | Numérico | Valor da cobrança |
Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente |
DiasGeracaoCobranca | Numérico | Dias para gerar a cobrança de assinatura |
IniciandoEm | Data | Data de início da assinatura |
FinalizandoEm | Data | Data de fim da assinatura |
FormasPagamento | Texto | Forma de pagamento da cobrança |
ProdutoId | GUID | Identificador único do produto caso houver |
Multa | Numérico | Valor da multa caso haja algum tipo de atraso |
JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento |
DescontoAteVencimento | Numérico | Desconto até a última data do vencimento da assinatura |
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 |
ClientePagamentosId | GUID | Id do cliente de pagamento |
Valor | Numérico | Valor da assinatura |