Documentação gerador-boleto

Pacote NPM Gerador de Boleto no padrão FEBRABAN: 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

Começando

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 o pacote no seu projeto usando um dos comandos abaixo.

NPM

Shell
npm install @box4dev/gerador-boleto

Yarn

Shell
yarn add @box4dev/gerador-boleto

PNPM

Shell
pnpm add @box4dev/gerador-boleto

Importação

Importe o gerador de boletos usando sintaxe ESM ou CommonJS.

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

Utilização

Todos os campos são opcionais. Caso nenhum parâmetro seja informado, o pacote escolhe um banco aleatório e valores válidos para o boleto.

Sem parâmetros

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.'
} 
*/

Apenas 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' }));

gerador_boleto_doc.documentation.usageParametersTitle

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',
  })
);

gerador_boleto_doc.documentation.usageParametersTitle

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

Gere boletos para estes bancos compatíveis e seus códigos de banco correspondentes.

BancoDescrição
santanderSantander (033)
bradescoBradesco (237)
caixaCaixa SIGCB (104)
itauItaú (341)

Contribuição

Contribuições são bem-vindas. Abra issues ou pull requests no repositório abaixo.

Repositório GitHub

Licença

Distribuído sob a licença MIT.

Segurança

Reporte problemas de segurança pela política de segurança do pacote no GitHub.

Perguntas Frequentes