Criar uma Assinatura

post

https://{apiHost}/v1/customer_subscriptions

Cria uma nova assinatura recorrente para cobrança automática de clientes com boletos bancários.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Informações a serem salvas na assinatura

customer_id

integer | null

ID do Cliente. Quando esse ID é passado, os campos customer_person_name, customer_cnpj_cpf, customer_zipcode, customer_address, customer_city_name, customer_state e customer_neighborhood não são obrigatórios.

customer_person_name

string

required

length ≤ 120

Nome do cliente

customer_nickname

string | null

Apelido ou Nome Fantasia do Pagador

customer_cnpj_cpf

string

required

length ≤ 20

CPF/CNPJ do cliente

customer_zipcode

string

required

length ≤ 8

CEP (formato 99999999)

customer_email

string | null

E-mail do Pagador

customer_email_cc

string | null

E-mail alternativo do Pagador

customer_address

string

required

length ≤ 255

Endereço

customer_city_name

string

required

length ≤ 60

Cidade(Nome deve estar correto e completo)

customer_state

string

required

length ≤ 2

Estado

customer_neighborhood

string

required

length ≤ 80

Bairro

customer_address_number

string

length ≤ 10

Número

customer_address_complement

string | null

Complemento

customer_phone_number

string | null

Telefone (com DDD, DDI é opcional)

customer_mobile_local_code

string | null

DDD do Celular

customer_mobile_number

string | null

Celular

customer_notes

string | null

Anotações do Pagador

customer_ignore_email

boolean | null

Nunca enviar e-mail para este cliente

customer_ignore_sms

boolean | null

Nunca enviar SMS para este cliente

customer_contact_person

string | null

Contato

customer_update

string | null

Contato

bank_billet_account_id

integer

required

ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.

amount

float

required

Valor da Assinatura (R$)

next_billing

date

Data da Primeira ou Próxima cobrança. Caso não seja enviado uma data, esse campo será calculado para ter o valor do dia da criação da assinatura mais o ciclo escolhido. Ex.: Mensal(Hoje + 30 dias)

end_at

date | null

Data em que deseja parar as cobranças. Caso em branco, as cobranças serão geradas automaticamente até que se informe uma data ou se exclua a assinatura.

description

string | null

Descrição do produto ou serviço

instructions

string | null

Instruções para o Caixa

days_in_advance

integer

Com quantos dias de antecedência à data de vencimento a cobrança será gerada. Default: 7.

fine_type

integer | null

enum

Defaults to 0

Tipo de multa:

0 Inexistente (Padrão)
1 Para percentual do valor do boleto
2 Para valor fixo

Allowed:

days_for_fine

integer | null

Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).

fine_percentage

float | null

Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1

fine_value

float | null

Valor da multa (R$). Obrigatório se fine_type é igual a 2.

interest_type

integer | null

enum

Defaults to 0

Tipo de juros/mora:

0 Inexistente (Padrão)
1 Para porcentagem diária
2 Para valor diário

Allowed:

days_for_interest

integer | null

Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).

interest_percentage

float | null

Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.

interest_value

float | null

Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.

discount_type

integer | null

enum

Defaults to 0

Tipo de desconto:

O tipo de desconto será o mesmo para todos os três descontos, caso existam. :

0 Inexistente (Padrão)
1 Para valor fixo
2 Para percentual do valor do boleto

Allowed:

days_for_discount

integer | null

Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)

discount_percentage

float | null

Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2

discount_value

float | null

Valor do desconto (R$). Obrigatório se discount_type é igual a 1.

days_for_second_discount

integer | null

Dias para segundo desconto.

second_discount_percentage

float | null

Percentual do valor do boleto equivalente ao segundo desconto.

second_discount_value

float | null

Valor do segundo desconto (R$).

days_for_third_discount

integer | null

Dias para terceiro desconto.

third_discount_percentage

float | null

Percentual do valor do boleto equivalente ao terceiro desconto.

third_discount_value

float | null

Valor do terceiro desconto (R$).

bank_billet_layout_id

integer | null

ID do Modelo de Boleto

notes

string | null

Anotações

tags

prevent_registration

boolean | null

Impedir envio de registro ao banco: Caso true, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema.

divergent_payment_type

integer | null

enum

Tipo de pagamento divergente:

Válido apenas para Itaú e Caixa.

1 Aceita qualquer valor divergente
2 Aceita pagamentos dentro de uma faixa de valores ou percentuais
3 Não aceita pagamento de valores divergentes
4 Aceita pagamentos de valores superiores a um valor ou percentual mínimo

Allowed:

divergent_payment_value_type

integer | null

enum

Tipo de valor a considerar para os limites de pagamentos:

Válido apenas para Itaú e Caixa.

1 Informa pagamentos divergentes por valores
2 Informa pagamentos divergentes por percentuais

Allowed:

divergent_payment_maximum_value

float | null

Valor máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_value

float | null

Valor mínimo para a faixa de pagamentos divergentes.

divergent_payment_maximum_percentage

float | null

Percentual máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_percentage

float | null

Percentual mínimo para a faixa de pagamentos divergentes.

divergent_payment_limit

integer | null

Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa.

custom_attachment_name

string | null

Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID.

guarantor_name

string | null

Nome do Beneficiário final (Sacador/Avalista)

guarantor_cnpj_cpf

string | null

CNPJ/CPF do Beneficiário final (Sacador/Avalista)

guarantor_address_number

string | null

Número do Beneficiário final (Sacador/Avalista)

guarantor_neighborhood

string | null

Bairro do Beneficiário final (Sacador/Avalista)

guarantor_phone_number

string | null

Telefone (com DDD) do Beneficiário final (Sacador/Avalista)

guarantor_city_name

string | null

Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)

guarantor_state

string | null

Estado do Beneficiário final (Sacador/Avalista)

guarantor_zipcode

string | null

CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)

guarantor_address

string | null

Endereço do Beneficiário final (Sacador/Avalista)

guarantor_address_complement

string | null

Complemento do Beneficiário final (Sacador/Avalista)

days_for_revoke

integer | null

Dias corridos para Baixa/Devolução:

              Nulo/Branco: Obedece ao padrão do banco.
              0: Baixa/Devolução no mesmo dia do vencimento.
              1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).

days_for_negativation

integer | null

≤ 99

Dias corridos para Negativação:

Disponível apenas para os seguintes bancos e formatos.

Banco | CNAB 240| CNAB 400 |Webservice
Bradesco | Sim | Sim | Não
Itaú | Não | Sim | Não

days_for_sue

integer | null

Dias corridos para Protesto

payment_count

integer | null

Quantidade de pagamentos parciais aceitos para este boleto.

ignore_whatsapp

boolean | null

Defaults to false

Nunca enviar esta asinatura por WhatsApp

Headers

User-Agent

string

Informar um e-mail válido para contatos.

X-Idempotency-Key

string

Chave de idempotência para evitar replay de processamento.

Responses

201Assinatura criada

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

422Assinatura inválida