Getting Started
About the Boleto Generator
Boleto generator in the FEBRABAN standard: typeable line and barcode.
No HTML, PDF or graphic rendering — just JSON-ready data.
Ideal for mass generation for automated testing.
Installation
Install the library using your preferred package manager:
NPM
Install via NPMYarn
Install via YarnPNPM
Install via PNPMImport
Import library functions in your TypeScript or JavaScript project:
import { gerarBoleto } from '@box4dev/gerador-boleto';const { gerarBoleto } = require('@box4dev/gerador-boleto');Usage
Generate complete bank slip data easily using default or custom values.
Basic Usage with Random Data
const dados = gerarBoleto();console.log(dados.codigoBarras);// '03396145000000996689025708991834007174230101'console.log(dados.linhaDigitavel);// '03399.02579 08991.834006 71742.301014 6 14500000099668'console.log(dados);/* { codigoBarras: '03396145000000996689025708991834007174230101', linhaDigitavel: '03399.02579 08991.834006 71742.301014 6 14500000099668', banco: 'santander', codigoBanco: '033-7', dataEmissao: '2026-05-13T00:00:00.000Z', dataVencimento: '2026-05-18T00:00:00.000Z', valorDocumento: 99668, nossoNumero: 918340071742, nossoNumeroDv: 3, agencia: 1674, codigoCedente: 257089, carteira: '101', localPagamento: 'Até o vencimento, preferencialmente no Banco Santander', instrucoesPagamento: 'Sr. Caixa, cobrar multa de 2% após o vencimento. Receber até 10 dias após o vencimento.'} */Examples by Bank
console.log(gerarBoleto({ banco: 'bradesco' }));console.log(gerarBoleto({ banco: 'caixa' }));console.log(gerarBoleto({ banco: 'itau' }));console.log(gerarBoleto({ banco: 'santander' }));Usage Parameters
console.log( gerarBoleto({ banco: 'bradesco', valorDocumento: 15990, nossoNumero: '12345678901', agencia: '1229', codigoCedente: '0000469', carteira: '9', }));Usage Parameters
console.log( gerarBoleto({ banco: 'caixa', dataEmissao: new Date(), dataVencimento: vencimento, valorDocumento: 88800, nossoNumero: '12345678987654321', agencia: '1234', codigoCedente: '654321', carteira: '14', localPagamento: 'Local Teste', numeroDocumento: '999888', cedente: 'Empresa Teste LTDA', cedenteCnpj: '54811186000198', instrucoesPagamento: 'Instrução Teste', identificadorEmissao: '4', }));Supported Banks
Currently the library officially supports the following banks:
| Bank | Description |
|---|---|
| santander | Banco Santander (Code 033) |
| bradesco | Banco Bradesco (Code 237) |
| caixa | Caixa Econômica Federal (Code 104) |
| itau | Banco Itaú Unibanco (Code 341) |
Contribution
Contributions are welcome! Check the contribution guide on GitHub:
@box4dev/gerador-boleto GitHub RepositoryLicense
Distributed under the MIT License. Free for personal and commercial use.
Security
Generated bank slips are purely computational and intended for testing. No sensitive banking information is collected or sent to external servers.