Documentación gerador-boleto

Paquete NPM Generador de Boleto en el estándar FEBRABAN: Línea Digitable y Código de Barras.

El @box4dev/gerador-boleto es una biblioteca open-source ligera para el ecosistema Node.js, diseñada específicamente para la generación dinámica de datos de boletos bancarios en el estándar FEBRABAN.

NPM versionNPM downloads

Empezando

Sobre el Generador de Boleto

Generador de Boleto en el estándar FEBRABAN: Línea Digitable y Código de Barras.

Sin HTML, PDF o renderización gráfica — solo datos listos para JSON.

Ideal para generación masiva para pruebas automatizadas.

Instalación

Instale el paquete en su proyecto usando uno de los comandos a continuación.

NPM

Shell
npm install @box4dev/gerador-boleto

Yarn

Shell
yarn add @box4dev/gerador-boleto

PNPM

Shell
pnpm add @box4dev/gerador-boleto

Importación

Importe el generador de boletos usando sintaxis ESM o CommonJS.

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

Uso

Todos los campos son opcionales. Si no se proporcionan parámetros, el paquete elige un banco aleatorio y valores válidos para el boleto.

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

Solo 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 útiles

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 útiles

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 soportados

Genere boletos para estos bancos compatibles y sus códigos de banco correspondientes.

BancoDescripción
santanderSantander (033)
bradescoBradesco (237)
caixaCaixa SIGCB (104)
itauItaú (341)

Contribución

Las contribuciones son bienvenidas. Abra issues o pull requests en el repositorio a continuación.

Repositorio GitHub

Licencia

Distribuido bajo la licencia MIT.

Seguridad

Informe problemas de seguridad a través de la política de seguridad del paquete en GitHub.

Preguntas Frecuentes