v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Assinaturas

Listar Assinaturas

Lista assinaturas.

get/v1/customer_subscriptions

Query parameters

customer_person_namestring

Filtro por Nome/Razão Social.

customer_cnpj_cpfstring

Filtro por CPF/CNPJ da assinatura. Deve ser formatado com máscara. Acha todos os registros cujo campo seja igual ao string.

customer_emailstring

Filtro por e-mail do cliente. Acha todos os registros cujo campo seja igual ao string.

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Response

Sucesso na listagem de assinaturas

idinteger

ID da assinatura

customer_idinteger nullable

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_namestring required

Nome do cliente

customer_nicknamestring nullable

Apelido ou Nome Fantasia do Pagador

customer_cnpj_cpfstring required

CPF/CNPJ do cliente

customer_zipcodestring required

CEP (formato 99999999)

customer_emailstring email nullable

E-mail do Pagador

customer_email_ccstring email nullable

E-mail alternativo do Pagador

customer_addressstring required

Endereço

customer_city_namestring required

Cidade(Nome deve estar correto e completo)

customer_statestring required

Estado

customer_neighborhoodstring required

Bairro

customer_address_numberstring

Número

customer_address_complementstring nullable

Complemento

customer_phone_numberstring nullable

Telefone (com DDD, DDI é opcional)

customer_person_type'individual' | 'juridical' nullable

Tipo de Pagador.

individual Pessoa Física
juridical Pessoa Jurídica

customer_mobile_local_codestring nullable

DDD do Celular

customer_mobile_numberstring nullable

Celular

customer_notesstring nullable

Observações do Pagador

customer_ignore_emailboolean nullable

Nunca enviar e-mail para este cliente

customer_ignore_smsboolean nullable

Nunca enviar SMS para este cliente

customer_contact_personstring nullable

Contato

customer_updatestring nullable

Contato

bank_billet_account_idinteger required

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

amountnumber float required

Valor da Assinatura (R$)

Ciclo da assinatura. Default: monthly

biweekly Quinzenal
bimonthly Bimestral
monthly Mensal
quarterly Trimestral
semiannual Semestral
annual Anual

next_billingstring 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_atstring date nullable

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.

descriptionstring nullable

Descrição do produto ou serviço

instructionsstring nullable

Instruções para o Caixa

days_in_advanceinteger

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

fine_type0 | 1 | 2 nullable

Tipo de multa:

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

days_for_fineinteger nullable

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_percentagenumber float nullable

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

fine_valuenumber float nullable

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

interest_type0 | 1 | 2 nullable

Tipo de juros/mora:

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

days_for_interestinteger nullable

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_percentagenumber float nullable

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_valuenumber float nullable

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

discount_type0 | 1 | 2 nullable

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

days_for_discountinteger nullable

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

discount_percentagenumber float nullable

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

discount_valuenumber float nullable

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

days_for_second_discountinteger nullable

Dias para segundo desconto.

second_discount_percentagenumber float nullable

Percentual do valor do boleto equivalente ao segundo desconto.

second_discount_valuenumber float nullable

Valor do segundo desconto (R$).

days_for_third_discountinteger nullable

Dias para terceiro desconto.

third_discount_percentagenumber float nullable

Percentual do valor do boleto equivalente ao terceiro desconto.

third_discount_valuenumber float nullable

Valor do terceiro desconto (R$).

bank_billet_layout_idinteger nullable

ID do Modelo de Boleto

notesstring nullable

Observações

tagsstring[] nullable

Tags associadas ao boleto

bank_billet_idsinteger[] nullable

IDs de boletos vinculados ao carnê

prevent_registrationboolean nullable

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_typenull | 1 | 2 | 3 | 4 nullable

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

divergent_payment_value_typenull | 1 | 2 nullable

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

divergent_payment_maximum_valuenumber float nullable

Valor máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_valuenumber float nullable

Valor mínimo para a faixa de pagamentos divergentes.

divergent_payment_maximum_percentagenumber float nullable

Percentual máximo para a faixa de pagamentos divergentes.

divergent_payment_minimum_percentagenumber float nullable

Percentual mínimo para a faixa de pagamentos divergentes.

divergent_payment_limitinteger nullable

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

custom_attachment_namestring nullable

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_namestring nullable

Nome do Beneficiário final (Sacador/Avalista)

guarantor_cnpj_cpfstring nullable

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

guarantor_address_numberstring nullable

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

guarantor_neighborhoodstring nullable

Bairro do Beneficiário final (Sacador/Avalista)

guarantor_phone_numberstring nullable

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

guarantor_city_namestring nullable

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

guarantor_statestring nullable

Estado do Beneficiário final (Sacador/Avalista)

guarantor_zipcodestring nullable

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

guarantor_addressstring nullable

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

guarantor_address_complementstring nullable

Complemento do Beneficiário final (Sacador/Avalista)

days_for_revokeinteger nullable

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_negativationinteger nullable

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_sueinteger nullable

Dias corridos para Protesto

payment_countinteger nullable

Quantidade de pagamentos parciais aceitos para este boleto.

import_idinteger nullable

ID da Importação

ignore_whatsappboolean nullable

Nunca enviar esta asinatura por WhatsApp

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro

Example response

[
  {
    "customer_person_name": "João Silva",
    "customer_cnpj_cpf": "16.974.923/0001-84",
    "customer_zipcode": "01310100",
    "customer_address": "Rua F, alamenda G",
    "customer_city_name": "São Paulo",
    "customer_state": "SP",
    "customer_neighborhood": "Centro",
    "amount": 10.99,
    "next_billing": "2022-12-12",
    "end_at": "2023-12-12",
    "days_in_advance": 10
  }
]