Referência da API
SiteCentral de AjudaAPI Status
Start typing to search…

Duplicar Boleto

post
https://{apiHost}/v1/bank_billets//duplicate

Duplica boleto permitindo alterar informações do novo boleto e ou cancelar o boleto duplicado

Path Params
string
required

ID do Boleto

Body Params

É permitido o envio de qualquer outro parâmetro do boleto.

integer

Nº de dias para vencimento a partir da data de hoje. Default: 7

float

Valor do novo Boleto

boolean | null

Cancelar o boleto que está sendo duplicado. Default: true

boolean | null

Atualizar o valor do novo boleto com juros e multa. Default: false

integer

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

integer | null

ID do Modelo de Boleto

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.

string
length ≤ 120

Nome do cliente

string
length ≤ 20

CPF/CNPJ do cliente

string
length ≤ 2

Estado

string
length ≤ 60

Cidade(Nome deve estar correto e completo)

string
length ≤ 8

CEP (formato 99999999)

string
length ≤ 255

Endereço

string
length ≤ 120

Complemento

string
length ≤ 10

Número

string
length ≤ 80

E-mail do Pagador

string
length ≤ 80

E-mail alternativo do Pagador

string
length ≤ 80

Bairro

string
length ≤ 15

Telefone (com DDD, DDI é opcional)

boolean | null

Nunca enviar e-mail para este cliente

boolean | null

Nunca enviar SMS para este cliente

string | null

DDD do Celular

string | null

Celular

string | null

Apelido ou Nome Fantasia do Pagador

string | null

Anotações do Pagador

string | null

Contato

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:
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).

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.

float | null

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

integer | null
enum
Defaults to 0

Tipo de Dias para juros:

  • 0 Corridos
  • 1 Úteis
Allowed:
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:
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).

float | null

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

float | null

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

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:
integer | null

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

float | null

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

float | null

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

integer | null

Dias para segundo desconto.

float | null

Percentual do valor do boleto equivalente ao segundo desconto.

float | null

Valor do segundo desconto (R$).

integer | null

Dias para terceiro desconto.

float | null

Percentual do valor do boleto equivalente ao terceiro desconto.

float | null

Valor do terceiro desconto (R$).

tags
array of strings | null

Tags associadas ao boleto

tags
integer | null
enum
Defaults to 1

Tipo de Cobrança:

  • 1 Simples
  • 2 Vinculada
  • 3 Descontada
  • 4 Vendor
Allowed:
integer | null
enum
Defaults to 1

Tipo de Cobrança: Quando o boleto precisa ser enviado pelo correio. É preciso contratar o serviço junto ao banco e pagará tarifa.

  • 1 Cliente
  • 2 Banco
Allowed:
string | null

Nome do Beneficiário final (Sacador/Avalista)

string | null

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

string | null

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

string | null

Bairro do Beneficiário final (Sacador/Avalista)

string | null

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

string | null

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

string | null

Estado do Beneficiário final (Sacador/Avalista)

string | null

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

string | null

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

string | null

Complemento do Beneficiário final (Sacador/Avalista)

string | null

Descrição do produto ou serviço

string | null

Instruções para o Caixa

date | null

Data do Documento

string
enum
Defaults to 02

Tipo de Documento:

  • Código | Sigla | Descrição
  • 01 | CH | Cheque
  • 02 | DM | Duplicata Mercantil (Padrão)
  • 03 | DMI | Duplicata Mercantil p/ Indicação
  • 04 | DS | Duplicata de Serviço
  • 05 | DSI | Duplicata de Serviço p/ Indicação
  • 06 | DR | Duplicata Rural
  • 07 | LC | Letra de Câmbio
  • 08 | NCC | Nota de Crédito Comercial
  • 09 | NCE | Nota de Crédito a Exportação
  • 10 | NCI | Nota de Crédito Industrial
  • 11 | NCR | Nota de Crédito Rural
  • 12 | NP | Nota Promissória
  • 13 | NPR | Nota Promissória Rural
  • 14 | TM | Triplicata Mercantil
  • 15 | TS | Triplicata de Serviço
  • 16 | NS | Nota de Seguro
  • 17 | RC | Recibo
  • 18 | FAT | Fatura
  • 19 | ND | Nota de Débito
  • 20 | AP | Apólice de Seguro
  • 21 | ME | Mensalidade Escolar
  • 22 | PC | Parcela de Consórcio
  • 23 | NF | Nota Fiscal
  • 24 | DD | Documento de Dívida
  • 25 | CPR | Cédula de Produto Rural
  • 26 | CTR | Contrato
  • 27 | CSG | Cosseguros
  • 28 | EC | Encargos Condominiais
  • 29 | CPS | Conta de Prestação de Serviços
  • 30 | WR | Warrant
  • 31 | DP | Duplicata Prestação
  • 32 | CSR | Cobrança Seriada
  • 33 | CAR | Carnê
  • 34 | ARE | Apólice Ramos Elementares
  • 35 | CC | Cartão de Crédito
  • 36 | BDP | Boleto de Proposta
  • 37 | NPD | Nota Promissória Direta
  • 38 | DAE | Dívida Ativa de Estado
  • 39 | DAM | Divida Ativa de Município
  • 40 | DAU | Dívida Ativa União
  • 41 | CCB | Célula de Crédito Bancário
  • 42 | FI | Financiamento
  • 43 | RD | Rateio de Despesas
  • 44 | DRI | Duplicata Rural p/ Indicação
  • 45 | ECI | Encargos Condominiais p/ Indicação
  • 99 | Outros | Outros
string | null

Número do Documento

string
enum
Defaults to N

Aceite:

  • N Não (Padrão)
  • S Sim
Allowed:
string | null

Nosso Número. Se não informado, usará o Próximo Nosso Número da Carteira de Cobrança.

float

Valor pago

date | null

Data do pagamento

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).
integer | null

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
integer | null
enum

Tipo de dias para protesto: * 0 Corridos * 1 Úteis

Allowed:
integer | null

Dias corridos para Protesto

string | null

Código de Protesto(CNAB 240). Consulte os possíveis valores para cada banco.

string | null

Código de Baixa(CNAB 240). Consulte os possíveis valores para cada banco.

string | null

Primeira Instrução(CNAB 400). Consulte os possíveis valores para cada banco.

string | null

Segunda Instrução(CNAB 400). Consulte os possíveis valores para cada banco.

boolean

Endereço

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:
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:
float | null

Valor mínimo para a faixa de pagamentos divergentes.

float | null

Valor máximo para a faixa de pagamentos divergentes.

float | null

Percentual mínimo para a faixa de pagamentos divergentes.

float | null

Percentual máximo para a faixa de pagamentos divergentes.

integer | null

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

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.

string | null

Número de controle:

Pode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno.

boolean | null
Defaults to false

Não enviar este boleto por email

boolean | null
Defaults to false

Nunca enviar este boleto por SMS

boolean | null
Defaults to false

Nunca enviar este boleto por WhatsApp

string | null

Endereço

custom_data
object | null

Hash com chave e valor no formato JSON.

meta
object | null
deprecated

Hash com chave e valor no formato JSON.

string | null

Anotações

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.

boolean | null

Split de Pagamento. Válido apenas para ABC Brasil (remessa CNAB 240), Itaú e Bradesco (remessa CNAB 400). Caso true, o rateio do boleto será registrado. Informar as contas para rateio em split_accounts

integer | null
enum

Tipo de Split de Pagamento: Válido apenas para Itau. Usado apenas com Split de Pagamento true.

  • 1 Rateio de crédito por percentual (%) – Valor nominal do título
  • 2 Rateio de crédito em valor (R$) – Valor nominal do título
  • 3 Rateio de crédito por percentual (%) – Valor líquido recebido
  • 4 Rateio de crédito em valor (R$) – Valor líquido recebido, rateado proporcionalmente
Allowed:
split_accounts
array of objects | null

Contas para Split de pagamento.

split_accounts
string | null

Local de Pagamento

integer | null

Quantidade de pagamentos parciais aceitos para este boleto.

string | null

Conta Destinatária + Dígito

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago