Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Boletos

Atualizar o Boleto

Atualiza informações específicas de um Boleto.

Você pode alterar boletos no status de Aberto(opened) ou Vencido(overdue)

Você receberá webhooks generating e opened para o boleto alterado.

Em carteiras registradas, a alteração irá entrar na remessa e pode ser cobrada taxa bancária.

put/v1/bank_billets/{id}

Path parameters

idstring required

ID do Boleto

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

amountnumber float

Valor do Boleto

expire_atstring date

Data de vencimento

tagsstring[] nullable

Tags associadas ao boleto

notesstring nullable

Observações

days_for_sue_typenull | 0 | 1 nullable

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

days_for_sueinteger nullable

Dias corridos para Protesto

days_for_revokeinteger nullable

Dias corridos para Baixa Bancos Suportados: Itaú

sue_codestring nullable

Código de Protesto(Somente por CNAB 240). Consulte os possíveis valores <a href="https://developers.kobana.com.br/reference/bancos-suportados" target="_blank">para cada banco</a>.

instructionsstring nullable

Instruções para o Caixa

descriptionstring nullable

Descrição do produto ou serviço

interest_type0 | 1 | 2 | 7 nullable

Tipo de juros/mora:

  • 0 Inexistente (Padrão)
  • 1 Para porcentagem diária
  • 2 Para valor diário
  • 7 Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi
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 de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais.

interest_valuenumber float nullable

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

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

reduction_type1 | 2 | 3 nullable

Tipo de abatimento:

1: Valor. 2: Porcentagem. 3: Sem abatimento

reduction_amountnumber float

Valor do abatimento. Obrigatório se reduction_type é igual a 1.

reduction_percentagenumber float nullable

Porcentagem de Abatimento. Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se reduction_type é igual a 2. Até 2 casas decimais.

divergent_payment_typenull | 1 | 2 | 3 | 4 nullable

Tipo de pagamento divergente:

  • 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 Bancos suportados: Itaú
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 Bancos suportados: Itaú
divergent_payment_maximum_valuenumber float nullable

Valor máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

divergent_payment_minimum_valuenumber float nullable

Valor mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

divergent_payment_maximum_percentagenumber float nullable

Percentual máximo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

divergent_payment_minimum_percentagenumber float nullable

Percentual mínimo para a faixa de pagamentos divergentes. Bancos suportados: Itaú

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

credit_bureaunull | 0 | 1 | 2 nullable

Birô de Crédito/Órgão Negativador.

0: Serasa. 1: Quod. 2: SPC

Opções disponíveis para cada banco suportado:

  • Banco do Brasil: Serasa e Quod.
days_for_negativationinteger nullable

Quantidade de dias após o vencimento para negativar o título.

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. Até 2 casas decimais.

fine_valuenumber float nullable

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

document_numberstring nullable

Número do Documento, Tamanho depende do banco, formato e forma de envio (API / EDI): * Itau |Cnab240| 10 | * Itau |Cnab400| 10 |

customer_person_namestring

Nome do cliente. Bancos Suportados: Santander

customer_cnpj_cpfstring

CPF/CNPJ do cliente. Bancos Suportados: Santander

customer_statestring

Estado. Bancos Suportados: Santander

customer_city_namestring

Cidade(Nome deve estar correto e completo). Bancos Suportados: Santander

customer_zipcodestring

CEP (formato 99999999). Bancos Suportados: Santander

customer_addressstring

Endereço. Bancos Suportados: Santander

customer_neighborhoodstring

Bairro. Bancos Suportados: Santander

guarantor_namestring nullable

Nome do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander

guarantor_cnpj_cpfstring nullable

CNPJ/CPF do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander

document_type'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '25' | '26' | '27' | '28' | '29' | '30' | '31' | '32' | '33' | '34' | '35' | '36' | '37' | '38' | '39' | '40' | '41' | '42' | '43' | '44' | '45' | '99'

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

              Bancos Suportados: Santander
control_numberstring nullable

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. Bancos Suportados: Santander

payment_countinteger nullable

Quantidade de pagamentos parciais aceitos para este boleto. Bancos Suportados: Santander

issued_atstring date nullable

Data de emissão. Bancos Suportados: Santander

bolepix_keystring nullable

Chave do bolepix. Bancos Suportados: Santander

pix_txidstring nullable

TxId do pix. Bancos Suportados: Santander

Example request

{
  "amount": 10.99,
  "expire_at": "2023-12-12",
  "reduction_amount": 30.25,
  "customer_person_name": "João Silva",
  "customer_cnpj_cpf": "16.974.923/0001-84",
  "customer_state": "SP",
  "customer_city_name": "São Paulo",
  "customer_zipcode": "01310100",
  "customer_address": "Rua F, alamenda G",
  "customer_neighborhood": "Centro",
  "issued_at": "2023-12-12"
}

Response

Boleto atualizado