---
title: "Insere assinatura"
method: POST
path: "/api/Assinatura"
tags: ["Assinatura"]
---

# Insere assinatura

`POST /api/Assinatura`

## Request

- Base URL: `https://pagamentos.meuk8.com.br/CobrancasAPI`
- URL: `https://pagamentos.meuk8.com.br/CobrancasAPI/api/Assinatura`
- Auth: OAuth 2
  - Password
  - Token URL: `/CobrancasAPI/token` scopes: `BknBankCobrancasAPI`

Esta API permite criar uma assinatura.

### Requisição 
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--|
| Id | GUID | Identificador único da assinatura | Não |
| ClienteId | GUID  |  Identificador único do cliente que será cobrado  | Sim |
| ClienteNome | Texto | Nome do cliente que será cobrado | Não | 
| Descricao | Texto | Breve descrição sobre a assinatura | Sim |
| Valor | Numérico  | Valor da assinatura | Sim |
| Periodicidade | Texto | Período no qual a cobrança da assinatura será enviada ao cliente - Todos, Mensal, Semanal, Quinzenal, Bimestral, Trimestral, Semestral, Anual | 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 término da assinatura | Não |
| FormasPagamento | Texto | Forma de pagamento da cobrança | Não |
| ProdutoId | GUID  |Identificador único do produto caso haja | Não (1) |
| Multa | Numérico  | Multa da assinatura, para pagamento após vencimento | Não |
| MultaCorrecao | Texto | Tipo da correção aplicada sobre a multa - "Percentual", "Valor", "Isento" | Não |
| JurosMes | Numérico | Juros ao mês da assinatura, para pagamento após vencimento | Não |
| JurosCorrecao | Texto | Tipo da correção aplicada sobre os juros - "Percentual", "Valor", "Isento" | Não |
| DescontoAteVencimento | Numérico  | Desconto para pagamento até o vencimento da assinatura | Não |
| DescontoCorrecao | Texto | Tipo da correção aplicada sobre o desconto - "Percentual", "Valor", "Isento" | Não |
| **SplitValores** | **Array de Objeto | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do MeuK8, a partir do código de cliente e do valor respectivo** | **Não** |
| ClientePagamentosId | GUID | Identificador único do cliente relacionado ao split | N
| Valor | Numérico | Valor de crédito para o participante do split | 
| AutoEmiteFormaPagamento | Booleano | Informa se o boleto ou pix foi emitido automaticamente. Precisa estar configurado no cliente para funcionar corretamente | Não | 

### Resposta 
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Id | GUID | Identificador único da assinatura | 
| ClienteId | GUID | Identificador único do cliente que será cobrado | 
| ClienteNome | Texto | Nome do cliente que será cobrado | 
| Descricao | Texto | Breve descrição sobre a assinatura | 
| Criacao | Data | Data em que a assinatura foi criada | 
| Valor | Numérico  | Valor da assinatura | 
| Periodicidade | Texto | Período no qual a cobrança da assinatura será enviada ao cliente | 
| DiasGeracaoCobranca | Número  | Dias para gerar a cobrança de assinatura | 
| IniciandoEm | Data | Data de início da assinatura | 
| FinalizandoEm | Data | Data de término da assinatura | 
| FormasPagamento | Texto | Formas de pagamento da assinatura | 
| ProdutoId | GUID  |Identificador único do produto caso haja  | 
| Multa | Numérico  | Multa da assinatura, para pagamento após vencimento | 
| MultaCorrecao | Texto | Tipo da correção aplicada sobre a multa - "Percentual", "Valor", "Isento" |
| JurosMes | Numérico | Juros ao mês da assinatura, para pagamento após vencimento | 
| JurosCorrecao | Texto | Tipo da correção aplicada sobre os juros - "Percentual", "Valor", "Isento" |
| DescontoAteVencimento | Numérico  | Desconto para pagamento até o vencimento da assinatura | 
| DescontoCorrecao | Texto | Tipo da correção aplicada sobre o desconto - "Percentual", "Valor", "Isento" |
| **SplitValores** | Array de Objeto | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas MeuK8, a partir do código de cliente e do valor respectivo | 
| Id | GUID | Identificador único do split | 
| ClientePagamentosId | GUID | Identificador único do cliente relacionado ao split | 
| Valor | Numérico | Valor de crédito para o participante do split | 
| AutoEmiteFormaPagamento | Booleano | Informa se o boleto ou pix foi emitido automaticamente | 
| **DadosPagamento** | Objeto | Dados agregados de pagamentos da assinatura, caso tenha alguma cobrança paga | 
| Id | GUID | Identificador único do Pagamento | 
| Situacao | Texto | Situação do pagamento | 
| DataPagamento | Data | Data do pagamento | 
| FormaPagamento | Texto | Forma de pagamento | 
| DadosPagamento | Texto | Dados do pagamento, ex: número do boleto ou copia e cola do pix |
| NumeroCobrancas | Número | Número de cobranças vinculadas |
| ValorPago | Numérico | Valor total pago (soma de todas cobranças pagas) | 
| ValorPrincipal | Numérico | Valor principal total pago | 
| ValorMultaJuros | Numérico | Valor total de multas/juros | 
| NumeroPagamento | Texto | Número do pagamento mais recente | 
| ValorTaxas | Numérico | Valor total das taxas associadas | 
| ValorLiquido | Numérico | Valor líquido total | 
| DataDisponibilizacao | Data | Data de disponibilização mais recente | 
| ReembolsadoAoCliente | Booleano | Indicação se algum pagamento foi reembolsado | 
| Antecipado | Booleano | Indicativo se algum pagamento foi antecipado | 
| TransacaoId | GUID | Id da Transação mais recente | 
| CobrancaId | GUID | Id da Cobrança mais recente paga | 
| CanalPagamento | Número | Canal por onde o pagamento foi realizado - "NaoDefinido = 0", "AgenciasPostosTradicionais = 1", "TerminalAutoAtendimento = 2", "Internet = 3", "Pix = 4", "CorrespondenteBancario = 5", "CentralAtendimento = 6", "ArquivoEletronico = 7", "DDA = 8", "CorrespondenteBancarioDigital = 9"| 
| MeioPagamento | Número | Meio de pagamento utilizado na transação - "NaoDefinido = 0", "Especie = 1", "DebitoEmConta = 2","CartaoCredito = 3", "Cheque = 4" |

## Headers

- `Aeskey` string, required

## Request body

- BknBankCobrancasAPIModelsAssinatura: Modelo de Assinaturas
  - `Id` string: Id da assinatura
  - `ClienteId` string, uuid: Id do cliente relacionado a assinatura
  - `ClienteNome` string: Nome do cliente relacionado a assinatura, somente para retornar dados
  - `Descricao` string, required: Descrição da assinatura
  - `Criacao` string, date-time: Data de criação da assinatura
  - `Valor` number, double: Valor da assinatura
  - `Periodicidade` 'Todos' | 'Mensal' | 'Semanal' | 'Quinzenal' | 'Bimestral' | 'Trimestral' | 'Semestral' | 'Anual': Periodicidade da assinatura
  - `DiasGeracaoCobranca` integer: Dias para gerar a cobrança de assinatura
  - `IniciandoEm` string, date-time: Data de início da assinatura
  - `FinalizandoEm` string, date-time: Data de término da assinatura
  - `FormasPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Formas de pagamento da assinatura
  - `ProdutoId` string, uuid: Id do produto da assinatura
  - `Multa` number, double: Valor
  - `MultaCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo da multa a ser aplicada
  - `JurosMes` number, double: Valor
  - `JurosCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo do juros a ser aplicado
  - `DescontoAteVencimento` number, double: Valor
  - `DescontoCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo do desconto a ser aplicado
  - `SplitValores` BknBankCobrancasAPIModelsSplitAssinaturaRequest[]: Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do MeuK8, a partir do código de cliente e do valor respectivo
    - `ClientePagamentosId` string, uuid: Id do cliente associado ao split
    - `Valor` number, double: Valor de crédito para o participante do split
  - `AutoEmiteFormaPagamento` boolean
  - `DadosPagamento` BknBankCobrancasAPIModelsDadosPagamentoAgregado: Modelo de Dados Agregados de Pagamento
    - `Id` string: Id da cobrança mais recentemente paga (null se nenhuma paga)
    - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação geral do pagamento
    - `DataPagamento` string, date-time: Data do pagamento mais recente
    - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento mais recente
    - `DadosPagamento` string: Dados do pagamento mais recente
    - `NumeroCobrancas` integer: Número de cobranças vinculadas
    - `ValorPago` number, double: Valor total pago (soma de todas cobranças pagas)
    - `ValorPrincipal` number, double: Valor principal total pago
    - `ValorMultaJuros` number, double: Valor total de multas/juros
    - `NumeroPagamento` string: Número do pagamento mais recente
    - `ValorTaxas` number, double: Valor total de taxas
    - `ValorLiquido` number, double: Valor líquido total
    - `DataDisponibilizacao` string, date-time: Data de disponibilização mais recente
    - `ReembolsadoAoCliente` boolean: Indicação se algum pagamento foi reembolsado
    - `Antecipado` boolean: Indicativo se algum pagamento foi antecipado
    - `TransacaoId` string, uuid: Id da Transação mais recente
    - `CobrancaId` string, uuid: Id da Cobrança mais recente paga
    - `NumeroCobrancasPagas` integer: Número de cobranças pagas
    - `NumeroCobrancasPendentes` integer: Número de cobranças pendentes
    - `NumeroCobrancasCanceladas` integer: Número de cobranças canceladas
    - `NumeroCobrancasInadimplentes` integer: Número de cobranças inadimplentes

## Response `201`

Assinatura criada

- BknBankCobrancasAPIModelsAssinatura: Modelo de Assinaturas
  - `Id` string: Id da assinatura
  - `ClienteId` string, uuid: Id do cliente relacionado a assinatura
  - `ClienteNome` string: Nome do cliente relacionado a assinatura, somente para retornar dados
  - `Descricao` string, required: Descrição da assinatura
  - `Criacao` string, date-time: Data de criação da assinatura
  - `Valor` number, double: Valor da assinatura
  - `Periodicidade` 'Todos' | 'Mensal' | 'Semanal' | 'Quinzenal' | 'Bimestral' | 'Trimestral' | 'Semestral' | 'Anual': Periodicidade da assinatura
  - `DiasGeracaoCobranca` integer: Dias para gerar a cobrança de assinatura
  - `IniciandoEm` string, date-time: Data de início da assinatura
  - `FinalizandoEm` string, date-time: Data de término da assinatura
  - `FormasPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Formas de pagamento da assinatura
  - `ProdutoId` string, uuid: Id do produto da assinatura
  - `Multa` number, double: Valor
  - `MultaCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo da multa a ser aplicada
  - `JurosMes` number, double: Valor
  - `JurosCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo do juros a ser aplicado
  - `DescontoAteVencimento` number, double: Valor
  - `DescontoCorrecao` 'Percentual' | 'Valor' | 'Diario' | 'Isento': Tipo do desconto a ser aplicado
  - `SplitValores` BknBankCobrancasAPIModelsSplitAssinaturaRequest[]: Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do MeuK8, a partir do código de cliente e do valor respectivo
    - `ClientePagamentosId` string, uuid: Id do cliente associado ao split
    - `Valor` number, double: Valor de crédito para o participante do split
  - `AutoEmiteFormaPagamento` boolean
  - `DadosPagamento` BknBankCobrancasAPIModelsDadosPagamentoAgregado: Modelo de Dados Agregados de Pagamento
    - `Id` string: Id da cobrança mais recentemente paga (null se nenhuma paga)
    - `Situacao` 'pendente' | 'pago' | 'atrasado': Situação geral do pagamento
    - `DataPagamento` string, date-time: Data do pagamento mais recente
    - `FormaPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta': Forma de pagamento mais recente
    - `DadosPagamento` string: Dados do pagamento mais recente
    - `NumeroCobrancas` integer: Número de cobranças vinculadas
    - `ValorPago` number, double: Valor total pago (soma de todas cobranças pagas)
    - `ValorPrincipal` number, double: Valor principal total pago
    - `ValorMultaJuros` number, double: Valor total de multas/juros
    - `NumeroPagamento` string: Número do pagamento mais recente
    - `ValorTaxas` number, double: Valor total de taxas
    - `ValorLiquido` number, double: Valor líquido total
    - `DataDisponibilizacao` string, date-time: Data de disponibilização mais recente
    - `ReembolsadoAoCliente` boolean: Indicação se algum pagamento foi reembolsado
    - `Antecipado` boolean: Indicativo se algum pagamento foi antecipado
    - `TransacaoId` string, uuid: Id da Transação mais recente
    - `CobrancaId` string, uuid: Id da Cobrança mais recente paga
    - `NumeroCobrancasPagas` integer: Número de cobranças pagas
    - `NumeroCobrancasPendentes` integer: Número de cobranças pendentes
    - `NumeroCobrancasCanceladas` integer: Número de cobranças canceladas
    - `NumeroCobrancasInadimplentes` integer: Número de cobranças inadimplentes

## Other responses

- `400`: Dados inválidos da assinatura
- `401`: Não autorizado
- `500`: Erro criando assinatura

---

[API](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as.md) - [All operations](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/meuk8/apis/k8-fintech-cobran-as/revisions/4b96dba8717a?raw)