Pular para o conteúdo principal

Documentação @box4dev/gerador-boleto

Gerador de boleto padrão FEBRABAN com linha digitável e código de barras.

O @box4dev/gerador-boleto é uma biblioteca open-source lightweight para o ecossistema Node.js, projetada especificamente para a geração dinâmica de dados de boletos bancários no padrão FEBRABAN.

NPM versionNPM downloads

Primeiros Passos

Sobre o Gerador de Boleto

Gerador de Boleto no padrão FEBRABAN: Linha Digitável e Código de Barras.

Sem HTML, PDF ou renderização gráfica — apenas dados prontos para JSON.

Ideal para geração de massa para testes automatizados.

Instalação

Instale a biblioteca utilizando o seu gerenciador de pacotes preferido:

NPM

Shell
Instalar via NPM

Yarn

Shell
Instalar via Yarn

PNPM

Shell
Instalar via PNPM

Importação

Importe as funções da biblioteca no seu projeto TypeScript ou JavaScript:

JS
import { gerarBoleto } from '@box4dev/gerador-boleto';
JS
const { gerarBoleto } = require('@box4dev/gerador-boleto');

Utilização

Gere dados completos de boletos com facilidade utilizando valores padrão ou customizados.

Uso Básico com Dados Aleatórios

JS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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.'
} 
*/

Exemplos por Banco

JS
1
2
3
4
5
6
7
console.log(gerarBoleto({ banco: 'bradesco' }));
console.log(gerarBoleto({ banco: 'caixa' }));
console.log(gerarBoleto({ banco: 'itau' }));
console.log(gerarBoleto({ banco: 'santander' }));

Parâmetros de Uso

JS
1
2
3
4
5
6
7
8
9
10
console.log(
  gerarBoleto({
    banco: 'bradesco',
    valorDocumento: 15990,
    nossoNumero: '12345678901',
    agencia: '1229',
    codigoCedente: '0000469',
    carteira: '9',
  })
);

Parâmetros de Uso

JS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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',
  })
);

Bancos suportados

Atualmente a biblioteca oferece suporte oficial aos seguintes bancos:

BancoDescrição
santanderBanco Santander (Código 033)
bradescoBanco Bradesco (Código 237)
caixaCaixa Econômica Federal (Código 104)
itauBanco Itaú Unibanco (Código 341)

Contribuição

Contribuições são bem-vindas! Consulte o guia de contribuição no GitHub:

Repositório GitHub do @box4dev/gerador-boleto

Licença

Distribuído sob a licença MIT. Livre para uso pessoal e comercial.

Segurança

Os boletos gerados são puramente computacionais e destinados a testes. Nenhuma informação bancária sensível é coletada ou enviada a servidores externos.

Perguntas Frequentes