Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Boletos

Visualizar o Boleto

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

get/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.

Response

Boleto encontrado

idinteger

ID do boleto

bank_billet_account_idinteger

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

bank_billet_layout_idinteger nullable

ID do Modelo de Boleto

amountnumber float required

Quantia

expire_atstring date required

Data de vencimento

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

CPF/CNPJ do cliente

customer_statestring required

Estado

customer_city_namestring required

Cidade(Nome deve estar correto e completo)

customer_zipcodestring required

CEP (formato 99999999)

customer_addressstring required

Endereço

customer_address_complementstring

Complemento

customer_address_numberstring

Número

customer_emailstring email

E-mail do Pagador

customer_email_ccstring email

E-mail alternativo do Pagador

customer_neighborhoodstring required

Bairro

customer_phone_numberstring

Telefone (com DDD, DDI é opcional)

customer_ignore_emailboolean nullable

Nunca enviar e-mail para este cliente

customer_ignore_smsboolean nullable

Nunca enviar SMS para este cliente

customer_mobile_local_codestring nullable

DDD do Celular

customer_mobile_numberstring nullable

Celular

customer_nicknamestring nullable

Apelido ou Nome Fantasia do Pagador

customer_notesstring nullable

Observações do Pagador

customer_contact_personstring nullable

Contato

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.

interest_days_type0 | 1 nullable

Tipo de Dias para juros:

  • 0 Corridos
  • 1 Úteis
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. Até 2 casas decimais.

fine_valuenumber float nullable

Valor da multa (R$). Obrigatório se fine_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$).

tagsstring[] nullable

Tags associadas ao boleto

tag_liststring nullable

Tags associadas ao boleto

charge_type1 | 2 | 3 | 4 nullable

Tipo de Cobrança:

  • 1 Simples
  • 2 Vinculada
  • 3 Descontada
  • 4 Vendor
dispatch_type1 | 2 nullable

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

descriptionstring nullable

Descrição do produto ou serviço

instructionsstring nullable

Instruções para o Caixa

document_datestring date nullable

Data do Documento

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

Tipo de Documento (Sigla)

document_numberstring nullable

Número do Documento, Tamanho depende do banco e formato do arquivo Remessa: * Banco | Formato| Tamanho | * Abc |Cnab240| 15 | * Ailos |Cnab240| 15 | * Arbi |Cnab240| 15 | * Banese |Cnab240| 15 | * Banestes |Cnab400| 10 | * Banrisul |Cnab240| 15 | * Banrisul |Cnab400| 10 | * Bb |Cnab240| 15 | * Bb |Cnab400| 10 | * Bib |Cnab240| 15 | * Bnb |Cnab400| 10 | * Bnpparibas |Cnab400| 10 | * Bradesco |Cnab240| 15 | * Bradesco |Cnab400| 10 | * Brb |Cnab400| 10 | * Caixa |Cnab240| 11 | * Caixa |Cnab400| 10 | * Caruana |Cnab400| 10 | * Citibank |Cnab400| 10 | * Credisis |Cnab240| 15 | * Cresol |Cnab240| 10 | * Cresol |Cnab400| 10 | * Cresol Bradesco |Cnab240| 15 | * Cresol Bradesco |Cnab400| 10 | * Daycoval |Cnab400| 10 | * Itau |Cnab240| 10 | * Itau |Cnab400| 10 | * Mercantil |Cnab240| 10 | * Moneyplus |Cnab240| 10 | * Rendimento |Cnab400| 10 | * Safra |Cnab400| 102 | * Santander |Cnab240| 15 | * Santander |Cnab400| 10 | * Semear |Cnab400| 10 | * Sicoob |Cnab240| 15 | * Sicoob |Cnab400| 10 | * Sicredi |Cnab240| 15 | * Sicredi |Cnab400| 10 | * Sofisa |Cnab240| 15 | * Unicred |Cnab240| 15 | * Uniprime |Cnab400| 10 | * Uniprime99 |Cnab400| 10 | * Santander |Cnab400| 10

acceptance'N' | 'S'

Aceite:

  • N Não (Padrão)
  • S Sim
our_numberstring nullable

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

processed_our_numberstring nullable

Nosso Número calculado com DV (formatado)

processed_our_number_rawstring nullable

Nosso Número calculado com DV (limpo)

paid_amountnumber float nullable

Valor pago

paid_atstring date nullable

Data do pagamento

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

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_typenull | 0 | 1 nullable

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

days_for_sueinteger nullable

Dias corridos para Protesto

sue_codestring nullable

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

revoke_codestring nullable

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

first_instructionstring nullable

Primeira Instrução(CNAB 400). Consulte os possíveis valores <a href="https://developers.kobana.com.br/reference/bancos-suportados" target="_blank">para cada banco</a>.

second_instructionstring nullable

Segunda Instrução(CNAB 400). Consulte os possíveis valores <a href="https://developers.kobana.com.br/reference/bancos-suportados" target="_blank">para cada banco</a>.

watermarkboolean

Endereço

payment_countinteger nullable

Quantidade de pagamentos parciais aceitos para este boleto.

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.

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.

issued_atstring date-time nullable

Data de emissão do boleto. Aceito somente quando prevent_registration: true.

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.

ignore_emailboolean nullable

Não enviar este boleto por email

ignore_smsboolean nullable

Nunca enviar este boleto por SMS

ignore_whatsappboolean nullable

Nunca enviar este boleto por WhatsApp

addonsstring jsonb nullable

Endereço

custom_dataobject nullable

Hash com chave e valor no formato JSON.

metaobject nullable

Hash com chave e valor no formato JSON.

notesstring nullable

Observações

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.

split_paymentboolean nullable

Split de Pagamento. Válido apenas para ABC Brasil, Bradesco e Itaú. Caso true, o rateio do boleto será registrado. Informar as contas para rateio em split_accounts. Para o Itaú, é necessário informar o tipo de split de pagamento em split_payment_type

split_payment_type1 | 2 | 3 | 4 nullable

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

Local de Pagamento

installment_idinteger nullable

ID do Carnê

installment_numberinteger nullable

Número da parcela do carnê

installment_totalinteger nullable

Total de parcelas do carnê

customer_subscription_idinteger nullable

ID da Assinatura

beneficiary_namestring

Nome do Beneficiário

beneficiary_cnpj_cpfstring

CNPJ/CPF do Beneficiário

beneficiary_addressstring

Endereço do Beneficiário

beneficiary_assignor_codestring nullable

Agência/Código do Beneficiário

bank_contract_slugstring nullable

Slug da Carteira

agency_numberstring

Agência

agency_digitstring

Dígito da Agência

account_numberstring

Conta

account_digitstring

Dígito da Conta

extra1string

Campo extra 1

extra1_digitstring nullable

Digito do Campo extra 1

extra2string nullable

Campo extra 2

extra2_digitstring nullable

Dígito do Campo extra 2

created_via_apiboolean nullable

Indica se o boleto foi criado por API

created_atstring date-time nullable

Data e hora de criação do boleto

updated_atstring date-time nullable

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

registration_status'pending' | 'skipped' | 'requested' | 'confirmed' | 'rejected' | 'failed'

Situação do registro no banco:

  • pending Pendente
  • skipped Ignorado
  • requested Requisitado
  • confirmed Confirmado
  • rejected Rejeitado (ainda será tentado novamente)
  • failed Falha (não será tentado novamente)
registered_atstring date-time nullable

Data e hora do registro (quando confirmado)

register_type1 | 2

Tipo de Registro:

  • 1 API
  • 2 Banco
cancel_typenull | 1 | 2 nullable

Tipo de Cancelamento:

  • 1 Cliente
  • 2 Banco
cancellation_reasonnull | 1 | 2 | 3 | 4 | 5 nullable

Motivo de Cancelamento:

  • 1 Outro
  • 2 Fraude
  • 3 Óbito
  • 4 Erro operacional
  • 5 Quitação paga
linestring nullable

Linha Digitável

barcodestring nullable

Código de Barras

shorten_urlstring nullable

URL para visualização do boleto

urlstring nullable

URL para visualização do boleto

carne_urlstring nullable

URL para visualização do carnê(Quando for parcela)

formatsobject nullable

URLs com formatos disponíveis. Ex.: PDF, Imagem, Pix e etc

pix_enabledboolean nullable

Indica se o boleto é híbrido e tem QRcode Pix

pix_qrcodestring nullable

QRcode Pix do boleto híbrido

pix_txidstring nullable

Campo txid do Pix. Gerado automaticamente por default caso não fornecido.

prevent_pixboolean nullable

Caso verdadeiro, impede a criação do Pix para carteiras com Pix habilitado. Não é considerado se a carteira não tem Pix habilitado.

status'generating' | 'draft' | 'generation_failed' | 'validation_failed' | 'opened' | 'canceled' | 'paid' | 'overdue' | 'blocked' | 'chargeback'

Situação do boleto:

  • generating Gerando
  • draft Rascunho
  • generation_failed Falha ao gerar
  • opened Aberto
  • canceled Cancelado
  • paid Pago
  • overdue Vencido
  • validation_failed Inválido
  • chargeback Estornado
recipient_accountstring nullable

Conta Destinatária + Dígito

reduction_type1 | 2 | 3 nullable

Tipo de abatimento:

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

reduction_amountnumber float nullable

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.

instructions_mode0 | 1 | 2 nullable

Cálculo de datas na Instrução para o Caixa:

  • 0 Não preencher as instruções para o caixa
  • 1 Calcular data pela via de registro (API/CNAB)
  • 2 Usar a data configurada no boleto
import_idinteger nullable

ID da Importação

virtual_bank_billet_idinteger nullable

ID do Boleto gerado por membro de contrato BackOffice. (BackOffice precisa estar habilitado).

external_idstring nullable

ID do boleto no sistema do cliente. Opcional para controle e busca interna.

financial_provider_external_idstring nullable

ID na instituição financeira

after_createstring[] nullable

Execução automática de comandos após o boleto ser criado. Valores permitidos: * sync: Sincronização com o provedor financeiro.

Example response

{
  "amount": 10.99,
  "expire_at": "2023-12-12",
  "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",
  "reduction_amount": 30.25
}